javax.xml.xquery
public interface ConnectionPoolXQDataSource
PooledXQConnection
objects.
An object that implements this interface will typically be
registered with a JNDI based naming service.
Method Summary | |
---|---|
int | getLoginTimeout()
Gets the maximum time in seconds that this datasource can wait while
attempting to connect to a database.
|
PrintWriter | getLogWriter()
Retrieves the log writer for this datasource object.
|
PooledXQConnection | getPooledConnection()
Attempts to establish a physical connection to an XML datasource
that can be used as a pooled connection.
|
PooledXQConnection | getPooledConnection(String user, String password)
Attempts to establish a physical connection to an XML datasource
using the supplied username and password, that can be used as a
pooled connection.
|
String | getProperty(String name)
Returns the current value of the named property if set, else
null . |
String[] | getSupportedPropertyNames()
Returns an array containing the property names supported by this
datasource.
|
void | setLoginTimeout(int seconds)
Sets the maximum time in seconds that this datasource will wait while
attempting to connect to a database. |
void | setLogWriter(PrintWriter out)
Sets the log writer for this datasource object to the given
java.io.PrintWriter object. |
void | setProperties(Properties props)
Sets the data source properties from the specified Properties
instance. |
void | setProperty(String name, String value)
Sets the named property to the specified value.
|
Returns: the datasource login time limit
Throws: XQException if a datasource access error occurs
null
; in other words, the default is for logging
to be disabled.
Returns: the log writer for this datasource or
null
if logging is disabled
Throws: XQException if a datasource access error occurs
Returns: a PooledXQConnection
object that is a physical
connection to the XML datasource that this
ConnectionPoolXQDataSource
object represents
Throws: XQException if a datasource access error occurs
Parameters: user the user on whose behalf the connection is being made password the user's password
Returns: a PooledXQConnection
object that is a physical
connection to the XML datasource that this
ConnectionPoolXQDataSource
object represents
Throws: XQException if a datasource access error occurs
null
. If the implementation does not support the
given property then an exception is raised.
Parameters: name the name of the property whose value is needed
Returns: String
representing the value of
the required property if set, else
null
Throws: XQException if a given property is not supported
Returns: String[]
an array of property names
supported by this implementation
Parameters: seconds the datasource login time limit
Throws: XQException if a datasource access error occurs
java.io.PrintWriter
object. The log writer is a character output
stream to which all logging and tracing messages for this datasource
will be printed. This includes messages printed by the methods of this
object, messages printed by methods of other objects manufactured by
this object, and so on. When a datasource object is created
the log writer is initially null
; in other words, the default
is for logging to be disabled.
Parameters: out the new log writer; to disable logging, set to
null
Throws: XQException if a datasource access error occurs
Properties
instance. Properties set before this call will still apply but
those with the same name as any of these properties will be replaced.
Properties set after this call also apply and may
replace properties set during this call.If the implementation does not support one or more of the given property names, or if it can determine that the value given for a specific property is invalid, then an exception is thrown. If an exception is thrown, then no previous value is overwritten. is invalid, then an exception is raised.
Parameters: props the list of properties to set
Throws: XQException if (1) a given property is not recognized, or (2) the value for a given property is determined to be invalid
If the implementation does not support the given property or if it can determine that the value given for this property is invalid, then an exception is thrown. If an exception is thrown, then no previous value is overwritten.
Parameters: name the name of the property to set value the value of the named property
Throws: XQException if (1) the given property is not recognized, or (2) the value for the given property is determined to be invalid