|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.basex.api.xqj.BXQDataSource
public final class BXQDataSource
Java XQuery API - Data Source.
Constructor Summary | |
---|---|
BXQDataSource()
Constructor. |
Method Summary | |
---|---|
BXQConnection |
getConnection()
Attempts to create a connection to an XML datasource. |
XQConnection |
getConnection(java.sql.Connection c)
Attempts to create a connection to an XML datasource using an existing JDBC connection. |
XQConnection |
getConnection(java.lang.String name,
java.lang.String pw)
Attempts to establish a connection to an XML datasource using the supplied username and password. |
int |
getLoginTimeout()
Gets the maximum time in seconds that this datasource can wait while attempting to connect to a database. |
java.io.PrintWriter |
getLogWriter()
Retrieves the log writer for this XQDataSource object. |
java.lang.String |
getProperty(java.lang.String key)
Returns the current value of the named property if set, else null . |
java.lang.String[] |
getSupportedPropertyNames()
Returns an array containing the property names supported by this XQDataSource . |
void |
setLoginTimeout(int to)
Sets the maximum time in seconds that this datasource will wait while attempting to connect to a database. |
void |
setLogWriter(java.io.PrintWriter out)
Sets the log writer for this XQDataSource object to the given
java.io.PrintWriter object. |
void |
setProperties(java.util.Properties prop)
Sets the data source properties from the specified Properties
instance. |
void |
setProperty(java.lang.String key,
java.lang.String val)
Sets the named property to the specified value. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BXQDataSource()
Method Detail |
---|
public BXQConnection getConnection()
XQDataSource
getConnection
in interface XQDataSource
public XQConnection getConnection(java.sql.Connection c) throws XQException
XQDataSource
XQException
)
is thrown. The XQJ and JDBC connections will operate under the same
transaction context.
getConnection
in interface XQDataSource
c
- an existing JDBC connection
XQException
- if (1) a datasource access error occurs,
(2) the implementation does not support
this method of getting an
XQConnection
, or (3) if
the con
parameter is null
public XQConnection getConnection(java.lang.String name, java.lang.String pw)
XQDataSource
getConnection
in interface XQDataSource
name
- the user on whose behalf the connection
is being madepw
- the user's password
public int getLoginTimeout()
XQDataSource
getLoginTimeout
in interface XQDataSource
public java.io.PrintWriter getLogWriter()
XQDataSource
XQDataSource
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 XQDataSource
object is created, the log writer is
initially null
; in other words, the default is for logging
to be disabled.
getLogWriter
in interface XQDataSource
null
if logging is disabledpublic java.lang.String getProperty(java.lang.String key) throws XQException
XQDataSource
null
. If the implementation does not support the
given property then an exception is raised.
getProperty
in interface XQDataSource
key
- the name of the property whose value is
needed
String
representing the value of
the required property if set, else
null
XQException
- if (1) a given property is not supported, or
(2) the name parameter is null
public java.lang.String[] getSupportedPropertyNames()
XQDataSource
XQDataSource
.
Implementations that support user name and password must recognize
the user name and password properties listed below.
user |
the user name to use for creating a connection |
password |
the password to use for creating a connection |
getSupportedPropertyNames
in interface XQDataSource
String[]
an array of property names
supported by this implementationpublic void setLoginTimeout(int to)
XQDataSource
XQDataSource
object is created, the login timeout is initially zero.
It is implementation-defined whether the specified login timeout is
actually used by the data source implementation. If the connection is
created over an existing JDBC connection, then the login timeout
value from the underlying JDBC connection may be used.
setLoginTimeout
in interface XQDataSource
to
- the datasource login time limitpublic void setLogWriter(java.io.PrintWriter out)
XQDataSource
XQDataSource
object to the given
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 XQDataSource
object is created
the log writer is initially null
; in other words, the default
is for logging to be disabled.
setLogWriter
in interface XQDataSource
out
- the new log writer; to disable logging, set to
null
public void setProperties(java.util.Properties prop) throws XQException
XQDataSource
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.
setProperties
in interface XQDataSource
prop
- the list of properties to set
XQException
- if (1) a given property is not recognized,
(2) the value for a given property is
determined to be invalid, or (3) the
props
parameter is null
public void setProperty(java.lang.String key, java.lang.String val) throws XQException
XQDataSource
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.
setProperty
in interface XQDataSource
key
- the name of the property to setval
- the value of the named property
XQException
- if (1) the given property is not recognized,
(2) the value for the given property is
determined to be invalid, or (3) the name
parameter is null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |