com.atomikos.jdbc.nonxa
Class NonXADataSourceBean

java.lang.Object
  com.atomikos.jdbc.nonxa.NonXADataSourceBean

All Implemented Interfaces:

HeuristicDataSource, Serializable, Referenceable, DataSource

public class NonXADataSourceBean
extends Object
implements HeuristicDataSource, Referenceable, Serializable

Copyright © 2004 Atomikos. All rights reserved. A Bean class for DataSource access to non-XA JDBC implementations. Instances are transaction-aware and can rollback the work done over multiple connections (provided that all work was done in one and the same thread).

See Also:

Serialized Form

Constructor Summary

NonXADataSourceBean()

Method Summary

void	close() Close the instance after use.
Connection	getConnection()
Connection	getConnection(HeuristicMessage msg) Get a connection to the datasource for the given description of the work.
Connection	getConnection(String msg) Get a connection to the datasource for the given description of the work.
Connection	getConnection(String user, String pass)
Connection	getConnection(String user, String passwd, HeuristicMessage msg) Get a connection to the datasource for the given description of the work.
Connection	getConnection(String user, String passwd, String msg) Get a connection to the datasource for the given description of the work.
int	getConnectionTimeout()
String	getDriverClassName()
int	getLoginTimeout()
PrintWriter	getLogWriter()
String	getPassword()
int	getPoolSize()
Reference	getReference()
boolean	getTestOnBorrow()
String	getUniqueResourceName()
String	getUrl()
String	getUser()
String	getValidatingQuery() Get the validating query
void	setConnectionTimeout(int secs) Set the refresh timeout interval for pool connections (optional).
void	setDriverClassName(String name) Set the name of the driver class that the DriverManager should use (required).
void	setLoginTimeout(int val)
void	setLogWriter(PrintWriter pw)
void	setPassword(String string) Set the password to use.
void	setPoolSize(int size) Set the minimum size of the pool (optional).
void	setTestOnBorrow(boolean value) Set whether connections should be tested when gotten.
void	setUniqueResourceName(String name) Set the JNDI name to bind on (required).
void	setUrl(String url) Set the URL to use for getting connections (required).
void	setUser(String string) Set the user name to get connections with.
void	setValidatingQuery(String query) Set a validating query for easy verification of connectivity (optional).
void	validate() Perform validation based on the validating query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NonXADataSourceBean

public NonXADataSourceBean()

Method Detail

getConnection

public Connection getConnection(HeuristicMessage msg)
                         throws SQLException

Description copied from interface: HeuristicDataSource

Get a connection to the datasource for the given description of the work.

Specified by:

getConnection in interface HeuristicDataSource

Parameters:

msg - The heuristic message that best describes the work about to be done.

Returns:

Connection The connection.

Throws:

SQLException - On error.

See Also:

HeuristicDataSource.getConnection(com.atomikos.icatch.HeuristicMessage)

getConnection

public Connection getConnection(String user,
                                String passwd,
                                HeuristicMessage msg)
                         throws SQLException

Description copied from interface: HeuristicDataSource

Get a connection to the datasource for the given description of the work.

Specified by:

getConnection in interface HeuristicDataSource

Parameters:

user - The user name to use.

passwd - The password.

msg - The heuristic message that best describes the work about to be done.

Returns:

Connection The connection.

Throws:

SQLException - On error.

See Also:

HeuristicDataSource.getConnection(java.lang.String, java.lang.String, com.atomikos.icatch.HeuristicMessage)

getReference

public Reference getReference()
                       throws NamingException

Specified by:

getReference in interface Referenceable

Throws:

NamingException

See Also:

Referenceable.getReference()

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

See Also:

DataSource.getConnection()

getConnection

public Connection getConnection(String user,
                                String pass)
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

See Also:

DataSource.getConnection(java.lang.String, java.lang.String)

getConnection

public Connection getConnection(String msg)
                         throws SQLException

Description copied from interface: HeuristicDataSource

Get a connection to the datasource for the given description of the work.

Specified by:

getConnection in interface HeuristicDataSource

Parameters:

msg - The heuristic message that best describes the work about to be done.

Returns:

Connection The connection.

Throws:

SQLException - On error.

See Also:

HeuristicDataSource.getConnection(java.lang.String, java.lang.String, com.atomikos.icatch.HeuristicMessage)

getConnection

public Connection getConnection(String user,
                                String passwd,
                                String msg)
                         throws SQLException

Description copied from interface: HeuristicDataSource

Get a connection to the datasource for the given description of the work.

Specified by:

getConnection in interface HeuristicDataSource

Parameters:

user - The user name to use.

passwd - The password.

msg - The heuristic message that best describes the work about to be done.

Returns:

Connection The connection.

Throws:

SQLException - On error.

See Also:

HeuristicDataSource.getConnection(java.lang.String, java.lang.String, com.atomikos.icatch.HeuristicMessage)

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

Specified by:

getLogWriter in interface DataSource

Throws:

SQLException

See Also:

DataSource.getLogWriter()

setLogWriter

public void setLogWriter(PrintWriter pw)
                  throws SQLException

Specified by:

setLogWriter in interface DataSource

Throws:

SQLException

See Also:

DataSource.setLogWriter(java.io.PrintWriter)

setLoginTimeout

public void setLoginTimeout(int val)
                     throws SQLException

Specified by:

setLoginTimeout in interface DataSource

Throws:

SQLException

See Also:

DataSource.setLoginTimeout(int)

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

Specified by:

getLoginTimeout in interface DataSource

Throws:

SQLException

See Also:

DataSource.getLoginTimeout()

getConnectionTimeout

public int getConnectionTimeout()

Returns:

The connection refresh timeout in secs.

getDriverClassName

public String getDriverClassName()

Returns:

The driver class to be used by the DriverManager.

getUniqueResourceName

public String getUniqueResourceName()

Returns:

The JNDI name to bind on.

getPassword

public String getPassword()

Returns:

The password.

getPoolSize

public int getPoolSize()

Returns:

The poolsize.

getUrl

public String getUrl()

Returns:

The URL to connect with.

getUser

public String getUser()

Returns:

The user to connect with.

setTestOnBorrow

public void setTestOnBorrow(boolean value)

Set whether connections should be tested when gotten.

Parameters:

value - Whether to test connections when taken out of the pool.

getTestOnBorrow

public boolean getTestOnBorrow()

Returns:

whether to test connections when gotten.

setConnectionTimeout

public void setConnectionTimeout(int secs)

Set the refresh timeout interval for pool connections (optional).

Parameters:

secs - The value in seconds.

setDriverClassName

public void setDriverClassName(String name)

Set the name of the driver class that the DriverManager should use (required).

Parameters:

name - The name.

setUniqueResourceName

public void setUniqueResourceName(String name)

Set the JNDI name to bind on (required). Should be unique.

Parameters:

name - The JNDI name.

setPassword

public void setPassword(String string)

Set the password to use.

Parameters:

string -

setPoolSize

public void setPoolSize(int size)

Set the minimum size of the pool (optional).

Parameters:

size -

setUrl

public void setUrl(String url)

Set the URL to use for getting connections (required).

Parameters:

url -

setUser

public void setUser(String string)

Set the user name to get connections with.

Parameters:

string -

setValidatingQuery

public void setValidatingQuery(String query)

Set a validating query for easy verification of connectivity (optional).

Parameters:

query -

getValidatingQuery

public String getValidatingQuery()

Get the validating query

Returns:

String The query.

close

public void close()

Close the instance after use. Calling this method will clean up the internal pool and housekeeping thread, so that the VM can exit normally.

validate

public void validate()
              throws SQLException

Perform validation based on the validating query. This method does nothing if no query was specified.

Throws:

SQLException - If validation fails.