io::zorba::api::xqj::ZorbaXQDataSourceAn ZorbaXQDataSource is a factory for ZorbaXQConnection objects.Public Static Attributes
Private Attributes
Protected Attributes
package-static-funcPublic Functions
Public Static AttributesZORBA_PROPERTIES_LIB_PATHSfinal String ZORBA_PROPERTIES_LIB_PATHS
ZORBA_PROPERTIES_MODULE_PATHSfinal String ZORBA_PROPERTIES_MODULE_PATHS
ZORBA_PROPERTIES_URI_PATHSfinal String ZORBA_PROPERTIES_URI_PATHS
Private AttributesloginTimeoutint loginTimeout
propertiesProperties properties
propertiesAllowedString[] propertiesAllowed
Protected AttributeslogWriterPrintWriter logWriter
package-static-func[static initializer] [static initializer]
Public FunctionsgetConnectionZorbaXQConnection getConnection() Attempts to create a connection to an XML datasource.
Returnsa connection to the XML datasourceParameters
getConnectionZorbaXQConnection getConnection(Connection cnctn) Attempts to create a connection to an XML datasource using an existing JDBC connection. An XQJ implementation is not required to support this method. If it is not supported, then an exception (XQException) is thrown. The XQJ and JDBC connections will operate under the same transaction context. Parameters
Returnsa connection to the XML datasourceParameters
getConnectionZorbaXQConnection getConnection(String username, String passwd) Attempts to establish a connection to an XML datasource using the supplied username and password.
Parameters
Returnsa connection to the XML datasourceParameters
getLoginTimeoutint getLoginTimeout() Gets the maximum time in seconds that this datasource can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a ZorbaXQDataSource object is created, the login timeout is initially zero. It is implementation-defined whether the returned login timeout is actually used by the data source implementation. Returnsthe datasource login time limitParameters
getLogWriterPrintWriter getLogWriter() Retrieves the log writer for this ZorbaXQDataSource 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 ZorbaXQDataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled. Returnsthe log writer for this datasource or null if logging is disabledParameters
getPropertyString getProperty(String name) Returns the current value of the named property if set, else null. If the implementation does not support the given property then an exception is raised. Parameters
ReturnsString representing the value of the required property if set, else nullParameters
getSupportedPropertyNamesString[] getSupportedPropertyNames() Returns an array containing the property names supported by this ZorbaXQDataSource. 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 connectionAny additional properties are implementation-defined. ReturnsString[] an array of property names supported by this implementationsetLoginTimeoutvoid setLoginTimeout(int seconds) Sets the maximum time in seconds that this datasource will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a ZorbaXQDataSource 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. Parameters
Parameters
setLogWritervoid setLogWriter(PrintWriter writer) Sets the log writer for this ZorbaXQDataSource 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 ZorbaXQDataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled. Parameters
Parameters
setPropertiesvoid setProperties(Properties prprts) Sets the data source properties from the specified 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
Parameters
setPropertyvoid setProperty(String name, String value) Sets the named property to the specified value. If a property with the same name was already set, then this method will override the old value for that property with the new value. 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
Parameters
ZorbaXQDataSource ZorbaXQDataSource()
|