mchange-commons-java 0.3.1 · com.mchange.v2.sql.filter.FilterDataSource

Modifier and Type	Field and Description
protected DataSource	inner

Access	Constructor and Description
public	FilterDataSource(DataSource inner)
public	FilterDataSource()

Method Summary

Modifier and Type	Method and Description
private void	__setInner(DataSource inner)
public Connection	getConnection() Implements javax.sql.DataSource.getConnection. Attempts to establish a connection with the data source that this `DataSource` object represents.
public Connection	getConnection(String the database user on whose behalf the connection is being made a, String the user's password b) Implements javax.sql.DataSource.getConnection. Attempts to establish a connection with the data source that this `DataSource` object represents.
public DataSource	getInner()
public int	getLoginTimeout() Implements javax.sql.DataSource.getLoginTimeout. Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
public PrintWriter	getLogWriter() Implements javax.sql.DataSource.getLogWriter. Retrieves the log writer for this `DataSource` object.
public Logger	getParentLogger() Implements javax.sql.CommonDataSource.getParentLogger. Return the parent Logger of all the Loggers used by this data source.
public boolean	isWrapperFor(Class<T> a Class defining an interface. a) Implements java.sql.Wrapper.isWrapperFor. Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
public void	setInner(DataSource inner)
public void	setLoginTimeout(int the data source login time limit a) Implements javax.sql.DataSource.setLoginTimeout. Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
public void	setLogWriter(PrintWriter the new log writer; to disable logging, set to null a) Implements javax.sql.DataSource.setLogWriter. Sets the log writer for this `DataSource` object to the given `java.io.PrintWriter` object.
public Object	unwrap(Class<T> A Class defining an interface that the result must implement. a) Implements java.sql.Wrapper.unwrap. Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

inner	back to summary
protected DataSource inner

FilterDataSource	back to summary
public FilterDataSource(DataSource inner)

FilterDataSource	back to summary
public FilterDataSource()

Method Detail

__setInner	back to summary
private void __setInner(DataSource inner)

getConnection back to summary

getConnection	back to summary
public Connection getConnection() throws SQLException Implements javax.sql.DataSource.getConnection. Doc from javax.sql.DataSource.getConnection. Attempts to establish a connection with the data source that this `DataSource` object represents. Returns:Connection a connection to the data source Exceptions SQLException: if a database access error occurs

public Connection getConnection() throws SQLException

Implements javax.sql.DataSource.getConnection.

Doc from javax.sql.DataSource.getConnection.

Attempts to establish a connection with the data source that this DataSource object represents.

Returns:Connection

a connection to the data source

Exceptions

SQLException:: if a database access error occurs

getConnection back to summary

getConnection	back to summary
public Connection getConnection(String a, String b) throws SQLException Implements javax.sql.DataSource.getConnection. Doc from javax.sql.DataSource.getConnection. Attempts to establish a connection with the data source that this `DataSource` object represents. Parameters a:String the database user on whose behalf the connection is being made b:String the user's password Returns:Connection a connection to the data source Exceptions SQLException: if a database access error occurs

public Connection getConnection(String a, String b) throws SQLException

Implements javax.sql.DataSource.getConnection.

Doc from javax.sql.DataSource.getConnection.

Attempts to establish a connection with the data source that this DataSource object represents.

Parameters

a:String: the database user on whose behalf the connection is being made
b:String: the user's password

Returns:Connection

a connection to the data source

Exceptions

SQLException:: if a database access error occurs

getInner	back to summary
public DataSource getInner()

getLoginTimeout back to summary

getLoginTimeout	back to summary
public int getLoginTimeout() throws SQLException Implements javax.sql.DataSource.getLoginTimeout. Doc from javax.sql.DataSource.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 a `DataSource` object is created, the login timeout is initially zero. Returns:int Doc from javax.sql.CommonDataSource.getLoginTimeout. the data source login time limit Exceptions SQLException: Doc from javax.sql.CommonDataSource.getLoginTimeout. if a database access error occurs.

public int getLoginTimeout() throws SQLException

Implements javax.sql.DataSource.getLoginTimeout.

Doc from javax.sql.DataSource.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 a DataSource object is created, the login timeout is initially zero.

Returns:int

Doc from javax.sql.CommonDataSource.getLoginTimeout.

the data source login time limit

Exceptions

SQLException:

Doc from javax.sql.CommonDataSource.getLoginTimeout.

if a database access error occurs.

getLogWriter back to summary

getLogWriter	back to summary
public PrintWriter getLogWriter() throws SQLException Implements javax.sql.DataSource.getLogWriter. Doc from javax.sql.DataSource.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 a `DataSource` object is created, the log writer is initially null; in other words, the default is for logging to be disabled. Returns:PrintWriter Doc from javax.sql.CommonDataSource.getLogWriter. the log writer for this data source or null if logging is disabled Exceptions SQLException: Doc from javax.sql.CommonDataSource.getLogWriter. if a database access error occurs

public PrintWriter getLogWriter() throws SQLException

Implements javax.sql.DataSource.getLogWriter.

Doc from javax.sql.DataSource.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 a DataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

Returns:PrintWriter

Doc from javax.sql.CommonDataSource.getLogWriter.

the log writer for this data source or null if logging is disabled

Exceptions

SQLException:

Doc from javax.sql.CommonDataSource.getLogWriter.

if a database access error occurs

getParentLogger back to summary

getParentLogger	back to summary
public Logger getParentLogger() throws SQLFeatureNotSupportedException Implements javax.sql.CommonDataSource.getParentLogger. Doc from javax.sql.CommonDataSource.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. Returns:Logger the parent Logger for this data source Exceptions SQLFeatureNotSupportedException: if the data source does not use `java.util.logging`

public Logger getParentLogger() throws SQLFeatureNotSupportedException

Implements javax.sql.CommonDataSource.getParentLogger.

Doc from javax.sql.CommonDataSource.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.

Returns:Logger

the parent Logger for this data source

Exceptions

SQLFeatureNotSupportedException:: if the data source does not use java.util.logging

isWrapperFor back to summary

isWrapperFor	back to summary
public boolean isWrapperFor(Class<T> a) throws SQLException Implements java.sql.Wrapper.isWrapperFor. Doc from java.sql.Wrapper.isWrapperFor. Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling `isWrapperFor` on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to `unwrap` so that callers can use this method to avoid expensive `unwrap` calls that may fail. If this method returns true then calling `unwrap` with the same argument should succeed. Parameters a:Class<T> a Class defining an interface. Returns:boolean true if this implements the interface or directly or indirectly wraps an object that does. Exceptions SQLException: if an error occurs while determining whether this is a wrapper for an object with the given interface.

public boolean isWrapperFor(Class<T> a) throws SQLException

Implements java.sql.Wrapper.isWrapperFor.

Doc from java.sql.Wrapper.isWrapperFor.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Parameters

a:Class<T>: a Class defining an interface.

Returns:boolean

true if this implements the interface or directly or indirectly wraps an object that does.

Exceptions

SQLException:: if an error occurs while determining whether this is a wrapper for an object with the given interface.

setInner	back to summary
public void setInner(DataSource inner)

setLoginTimeout back to summary

setLoginTimeout	back to summary
public void setLoginTimeout(int a) throws SQLException Implements javax.sql.DataSource.setLoginTimeout. Doc from javax.sql.DataSource.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. Parameters a:int Doc from javax.sql.CommonDataSource.setLoginTimeout. the data source login time limit Exceptions SQLException: Doc from javax.sql.CommonDataSource.setLoginTimeout. if a database access error occurs.

public void setLoginTimeout(int a) throws SQLException

Implements javax.sql.DataSource.setLoginTimeout.

Doc from javax.sql.DataSource.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.

Parameters

a:int

Doc from javax.sql.CommonDataSource.setLoginTimeout.

the data source login time limit

Exceptions

SQLException:

Doc from javax.sql.CommonDataSource.setLoginTimeout.

if a database access error occurs.

setLogWriter back to summary

setLogWriter	back to summary
public void setLogWriter(PrintWriter a) throws SQLException Implements javax.sql.DataSource.setLogWriter. Doc from javax.sql.DataSource.setLogWriter. Sets the log writer for this `DataSource` 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 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 a `DataSource` object is created the log writer is initially null; in other words, the default is for logging to be disabled. Parameters a:PrintWriter Doc from javax.sql.CommonDataSource.setLogWriter. the new log writer; to disable logging, set to null Exceptions SQLException: Doc from javax.sql.CommonDataSource.setLogWriter. if a database access error occurs

public void setLogWriter(PrintWriter a) throws SQLException

Implements javax.sql.DataSource.setLogWriter.

Doc from javax.sql.DataSource.setLogWriter.

Sets the log writer for this DataSource 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 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 a DataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled.

Parameters

a:PrintWriter

Doc from javax.sql.CommonDataSource.setLogWriter.

the new log writer; to disable logging, set to null

Exceptions

SQLException:

Doc from javax.sql.CommonDataSource.setLogWriter.

if a database access error occurs

unwrap back to summary

unwrap	back to summary
public Object unwrap(Class<T> a) throws SQLException Implements java.sql.Wrapper.unwrap. Doc from java.sql.Wrapper.unwrap. Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling `unwrap` recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an `SQLException` is thrown. Parameters a:Class<T> A Class defining an interface that the result must implement. Returns:Object an object that implements the interface. May be a proxy for the actual implementing object. Exceptions SQLException: If no object found that implements the interface

public Object unwrap(Class<T> a) throws SQLException

Implements java.sql.Wrapper.unwrap.

Doc from java.sql.Wrapper.unwrap.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Parameters

a:Class<T>: A Class defining an interface that the result must implement.

Returns:Object

an object that implements the interface. May be a proxy for the actual implementing object.

Exceptions

SQLException:: If no object found that implements the interface

public abstract Class FilterDataSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail