org.ow2.jonas.jndi.interceptors.impl.datasource
Class DatasourceWrapper

java.lang.Object
  extended by org.ow2.jonas.jndi.interceptors.impl.datasource.DatasourceWrapper
All Implemented Interfaces:
DataSource, IResourceChecker

public class DatasourceWrapper
extends Object
implements DataSource, IResourceChecker

Wrapper of existing datasources. Each call to getConnection(*) is kept in order to check if close have been done when detect method is called.

Author:
Florent Benoit

Constructor Summary
DatasourceWrapper(DataSource wrappedDataSource)
          Wrap a given datasource.
 
Method Summary
 void detect(IResourceCheckerInfo resourceCheckerInfo)
          Callback occuring in order to check if there are problems.
 boolean equals(Object other)
          Change equals method to use the equals on the underlying wrapped object.
 Connection getConnection()
           Attempts to establish a connection with the data source that this DataSource object represents.
 Connection getConnection(String username, String password)
           Attempts to establish a connection with the data source that this DataSource object represents.
 int getLoginTimeout()
          Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
 PrintWriter getLogWriter()
           Retrieves the log writer for this DataSource object.
 String getMapperName()
          Method implemented by some datasources.
 int hashCode()
           
protected  void remove(Long id)
          Remove the data for the given connection id.
 void setForceClose(boolean forceClose)
          Sets the flag for automatically closing or not the connection.
 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 this DataSource object to the given java.io.PrintWriter object.
protected  Connection wrapConnection(Connection connection, StackTraceElement[] stackTraceElements)
          Wrap the given connection and return it to the client.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DatasourceWrapper

public DatasourceWrapper(DataSource wrappedDataSource)
Wrap a given datasource.

Parameters:
wrappedDataSource - the given datasource
Method Detail

getConnection

public Connection getConnection()
                         throws SQLException

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

Specified by:
getConnection in interface DataSource
Returns:
a connection to the data source
Throws:
SQLException - if a database access error occurs

getConnection

public Connection getConnection(String username,
                                String password)
                         throws SQLException

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

Specified by:
getConnection in interface DataSource
Parameters:
username - the database user on whose behalf the connection is being made
password - the user's password
Returns:
a connection to the data source
Throws:
SQLException - if a database access error occurs

wrapConnection

protected Connection wrapConnection(Connection connection,
                                    StackTraceElement[] stackTraceElements)
Wrap the given connection and return it to the client.

Parameters:
connection - the connection to wrap
stackTraceElements - the stack trace
Returns:
the wrapped connection

remove

protected void remove(Long id)
Remove the data for the given connection id.

Parameters:
id - the connection ID

detect

public void detect(IResourceCheckerInfo resourceCheckerInfo)
Callback occuring in order to check if there are problems.

Specified by:
detect in interface IResourceChecker
Parameters:
resourceCheckerInfo - some data for the resource checker

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

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.

Specified by:
getLogWriter in interface DataSource
Returns:
the log writer for this data source or null if logging is disabled
Throws:
SQLException - if a database access error occurs
See Also:
setLogWriter(java.io.PrintWriter)

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

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.

Specified by:
setLogWriter in interface DataSource
Parameters:
out - the new log writer; to disable logging, set to null
Throws:
SQLException - if a database access error occurs
See Also:
getLogWriter()

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

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 interface DataSource
Parameters:
seconds - the data source login time limit
Throws:
SQLException - if a database access error occurs.
See Also:
getLoginTimeout()

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException
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.

Specified by:
getLoginTimeout in interface DataSource
Returns:
the data source login time limit
Throws:
SQLException - if a database access error occurs.
See Also:
setLoginTimeout(int)

getMapperName

public String getMapperName()
Method implemented by some datasources.

Returns:
the optional mapper name

setForceClose

public void setForceClose(boolean forceClose)
Sets the flag for automatically closing or not the connection.

Parameters:
forceClose - the given boolean value

equals

public boolean equals(Object other)
Change equals method to use the equals on the underlying wrapped object. For example jorm is comparing the datasource objects and if they're different, some merge is not occuring.

Overrides:
equals in class Object
Parameters:
other - the other object to compare
Returns:
true if objects are equals.

hashCode

public int hashCode()
Overrides:
hashCode in class Object
Returns:
the hashCode of the wrapped object.


Copyright © 2010 OW2 Consortium. All Rights Reserved.