|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConnectionPoolXQDataSource
A factory for 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. |
Method Detail |
---|
PooledXQConnection getPooledConnection() throws XQException
PooledXQConnection
object that is a physical
connection to the XML datasource that this
ConnectionPoolXQDataSource
object represents
XQException
- if a datasource access error occursPooledXQConnection getPooledConnection(String user, String password) throws XQException
user
- the user on whose behalf the connection is being madepassword
- the user's password
PooledXQConnection
object that is a physical
connection to the XML datasource that this
ConnectionPoolXQDataSource
object represents
XQException
- if a datasource access error occursint getLoginTimeout() throws XQException
XQException
- if a datasource access error occursPrintWriter getLogWriter() throws XQException
null
; in other words, the default is for logging
to be disabled.
null
if logging is disabled
XQException
- if a datasource access error occursString[] getSupportedPropertyNames()
String[]
an array of property names
supported by this implementationvoid setProperty(String name, String value) throws XQException
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.
name
- the name of the property to setvalue
- the value of the named property
XQException
- if (1) the given property is not recognized,
or (2) the value for the given property is
determined to be invalidString getProperty(String name) throws XQException
null
. If the implementation does not support the
given property then an exception is raised.
name
- the name of the property whose value is
needed
String
representing the value of
the required property if set, else
null
XQException
- if a given property is not supportedvoid setProperties(Properties props) throws XQException
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.
props
- the list of properties to set
XQException
- if (1) a given property is not recognized,
or (2) the value for a given property is
determined to be invalidvoid setLoginTimeout(int seconds) throws XQException
seconds
- the datasource login time limit
XQException
- if a datasource access error occursvoid setLogWriter(PrintWriter out) throws XQException
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.
out
- the new log writer; to disable logging, set to
null
XQException
- if a datasource access error occurs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |