- All Implemented Interfaces:
Serializable
,CommonDataSource
- Direct Known Subclasses:
JDBCDataSource
,JDBCPooledDataSource
,JDBCXADataSource
- Since:
- JDK 1.2, HSQLDB 2.0
- Author:
- Fred Toussi (fredt@users dot sourceforge.net)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSynonym for getUrl().Synonym for getUrl().Retrieves the name of the data source.Retrieves the description of the data source.int
Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.Retrieves the log writer for thisDataSource
object.Retrieves the network protocol of the data source.Return the parent Logger of all the Loggers used by this data source.Retrieves the server name attribute.getUrl()
Retrieves the jdbc database connection url attribute.getURL()
Retrieves the jdbc database connection url attribute.getUser()
Retrieves the user name for the connection.void
setDatabase
(String database) Synonym for setUrl(String).void
setDatabaseName
(String databaseName) Synonym for setUrl(String).void
setLoginTimeout
(int seconds) Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.void
setLogWriter
(PrintWriter out) Sets the log writer for thisDataSource
object to the givenjava.io.PrintWriter
object.void
setPassword
(String password) Sets the password for the user name.void
setProperties
(Properties props) Sets connection properties.void
Sets the jdbc database URL.void
Sets the jdbc database URL.void
Sets the user name.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.sql.CommonDataSource
createShardingKeyBuilder
-
Constructor Details
-
JDBCCommonDataSource
public JDBCCommonDataSource()
-
-
Method Details
-
getLogWriter
Retrieves the log writer for this
DataSource
object.The log writer is a character output stream to which all logging and tracing messages for this data source 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. Messages printed to a data source specific log writer are not printed to the log writer associated with the
java.sql.DriverManager
class. When aDataSource
object is created, the log writer is initially null; in other words, the default is for logging to be disabled.- Specified by:
getLogWriter
in interfaceCommonDataSource
- Returns:
- the log writer for this data source or null if logging is disabled
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
setLogWriter
Sets the log writer for this
DataSource
object to the givenjava.io.PrintWriter
object.The log writer is a character output stream to which all logging and tracing messages for this data source 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. Messages printed to a data source- specific log writer are not printed to the log writer associated with the
java.sql.DriverManager
class. When aDataSource
object is created the log writer is initially null; in other words, the default is for logging to be disabled.- Specified by:
setLogWriter
in interfaceCommonDataSource
- Parameters:
out
- the new log writer; to disable logging, set to null- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
setLoginTimeout
Sets the maximum time in seconds that this data source 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
DataSource
object is created, the login timeout is initially zero.- Specified by:
setLoginTimeout
in interfaceCommonDataSource
- Parameters:
seconds
- the data source login time limit- Throws:
SQLException
- if a database access error occurs.- Since:
- 1.4
- See Also:
-
getLoginTimeout
Gets the maximum time in seconds that this data source 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 aDataSource
object is created, the login timeout is initially zero.- Specified by:
getLoginTimeout
in interfaceCommonDataSource
- Returns:
- the data source login time limit
- Throws:
SQLException
- if a database access error occurs.- Since:
- 1.4
- See Also:
-
getDescription
Retrieves the description of the data source.- Returns:
- the description
-
getDataSourceName
Retrieves the name of the data source.- Returns:
- the description
-
getNetworkProtocol
Retrieves the network protocol of the data source.- Returns:
- the network protocol
-
getServerName
Retrieves the server name attribute.- Returns:
- the server name attribute
-
getDatabaseName
Synonym for getUrl().- Returns:
- the jdbc database connection url attribute
-
getDatabase
Synonym for getUrl().- Returns:
- the jdbc database connection url attribute
-
getUrl
Retrieves the jdbc database connection url attribute.- Returns:
- the jdbc database connection url attribute
-
getURL
Retrieves the jdbc database connection url attribute.- Returns:
- the jdbc database connection url attribute
-
getUser
Retrieves the user name for the connection.- Returns:
- the username for the connection
-
setDatabaseName
Synonym for setUrl(String).- Parameters:
databaseName
- the new value for the attribute
-
setDatabase
Synonym for setUrl(String).- Parameters:
database
- the new value for the attribute
-
setUrl
Sets the jdbc database URL.- Parameters:
url
- the new value of this object's jdbc database connection url attribute
-
setURL
Sets the jdbc database URL.- Parameters:
url
- the new value of this object's jdbc database connection url attribute
-
setPassword
Sets the password for the user name.- Parameters:
password
- the password
-
setUser
Sets the user name.- Parameters:
user
- the user id
-
setProperties
Sets connection properties. If user / password / loginTimeout has been set with one of the setXXX() methods it will be added to the Properties object.- Parameters:
props
- properties. If null, then existing properties will be cleared/replaced.
-
getParentLogger
Return the parent Logger of all the Loggers used by this data source. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source. Configuring this Logger will affect all of the log messages generated by the data source. In the worst case, this may be the root Logger.- Specified by:
getParentLogger
in interfaceCommonDataSource
- Returns:
- the parent Logger for this data source
- Throws:
SQLFeatureNotSupportedException
- if the data source does not usejava.util.logging
.- Since:
- JDK 1.7 M11 2010/09/10 (b123), HSQLDB 2.0.1
-