org.objectweb.jonas.dbm
Class JManagedConnection

java.lang.Object
  org.objectweb.jonas.dbm.JManagedConnection

All Implemented Interfaces:

java.lang.Comparable, javax.sql.PooledConnection, org.objectweb.transaction.jta.ResourceManagerEvent, javax.transaction.Synchronization, javax.sql.XAConnection, javax.transaction.xa.XAResource

public class JManagedConnection

extends java.lang.Object

implements java.lang.Comparable, javax.sql.XAConnection, javax.transaction.xa.XAResource, org.objectweb.transaction.jta.ResourceManagerEvent, javax.transaction.Synchronization

This class represents the physical connection, managed by the pool. It implements the PooledConnection interface, in fact via the derived XAConnection interface.

Author:

durieuxp

Field Summary

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

JManagedConnection(java.sql.Connection conn, ConnectionManager ds)

Method Summary

void	addConnectionEventListener(javax.sql.ConnectionEventListener listener) Add an event listener.
void	afterCompletion(int status) synchronization implementation
void	beforeCompletion() synchronization implementation
void	close() Close the database connection.
void	commit(javax.transaction.xa.Xid xid, boolean onePhase) Commit the global transaction specified by xid.
int	compareTo(java.lang.Object o)
void	end(javax.transaction.xa.Xid xid, int flags) Ends the work performed on behalf of a transaction branch.
void	enlistConnection(javax.transaction.Transaction transaction) implementation of resource manager event
void	forget(javax.transaction.xa.Xid xid) Tell the resource manager to forget about a heuristically completed transaction branch.
java.sql.Connection	getConnection() Create an object handle for a database connection.
int	getIdent()
int	getOpenCount()
java.lang.String	getRMID()
int	getTransactionTimeout() Obtain the current transaction timeout value set for this XAResource instance.
javax.transaction.Transaction	getTx()
javax.transaction.xa.XAResource	getXAResource() Return an XA resource to the caller.
void	hold() Notify as opened
boolean	inactive() Check if the connection has been unused for too long time.
boolean	isAged()
boolean	isClosed()
boolean	isOpen()
boolean	isRME()
boolean	isSameRM(javax.transaction.xa.XAResource xares) Determine if the resource manager instance represented by the target object is the same as the resource manager instance represented by the parameter xares
void	notifyClose()
void	notifyError(java.sql.SQLException ex)
void	notifyPsClose(JStatement ps) A PreparedStatement has been logically closed.
int	prepare(javax.transaction.xa.Xid xid) Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql) Try to find a PreparedStatement in the pool
java.sql.PreparedStatement	prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency) Try to find a PreparedStatement in the pool
int	psNumber()
javax.transaction.xa.Xid[]	recover(int flag) Obtain a list of prepared transaction branches from a resource manager.
boolean	release() notify as closed
void	remove() remove this item, ignoring exception on close.
void	removeConnectionEventListener(javax.sql.ConnectionEventListener listener) Remove an event listener.
void	rollback(javax.transaction.xa.Xid xid) Inform the resource manager to roll back work done on behalf of a transaction branch
void	setPstmtMax(int max) Dynamically change the prepared statement pool size
void	setRME(boolean rme) set/unset as RME
boolean	setTransactionTimeout(int seconds) Set the current transaction timeout value for this XAResource instance.
void	setTx(javax.transaction.Transaction tx) Set the associated transaction
void	start(javax.transaction.xa.Xid xid, int flags) Start work on behalf of a transaction branch specified in xid

Methods inherited from class java.lang.Object

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

Constructor Detail

JManagedConnection

public JManagedConnection(java.sql.Connection conn,
                          ConnectionManager ds)

Method Detail

getIdent

public int getIdent()

Returns:

The ident of this JManagedConnection

setPstmtMax

public void setPstmtMax(int max)

Dynamically change the prepared statement pool size

commit

public void commit(javax.transaction.xa.Xid xid,
                   boolean onePhase)
            throws javax.transaction.xa.XAException

Commit the global transaction specified by xid.

Specified by:

commit in interface javax.transaction.xa.XAResource

Parameters:

xid - transaction xid

onePhase - true if one phase commit

Throws:

javax.transaction.xa.XAException - XA protocol error

end

public void end(javax.transaction.xa.Xid xid,
                int flags)
         throws javax.transaction.xa.XAException

Ends the work performed on behalf of a transaction branch.

Specified by:

end in interface javax.transaction.xa.XAResource

Parameters:

xid - transaction xid

flags - currently unused

Throws:

javax.transaction.xa.XAException - XA protocol error

forget

public void forget(javax.transaction.xa.Xid xid)
            throws javax.transaction.xa.XAException

Tell the resource manager to forget about a heuristically completed transaction branch.

Specified by:

forget in interface javax.transaction.xa.XAResource

Parameters:

xid - transaction xid

Throws:

javax.transaction.xa.XAException - XA protocol error

getTransactionTimeout

public int getTransactionTimeout()
                          throws javax.transaction.xa.XAException

Obtain the current transaction timeout value set for this XAResource instance.

Specified by:

getTransactionTimeout in interface javax.transaction.xa.XAResource

Returns:

the current transaction timeout in seconds

Throws:

javax.transaction.xa.XAException - XA protocol error

isSameRM

public boolean isSameRM(javax.transaction.xa.XAResource xares)
                 throws javax.transaction.xa.XAException

Determine if the resource manager instance represented by the target object is the same as the resource manager instance represented by the parameter xares

Specified by:

isSameRM in interface javax.transaction.xa.XAResource

Parameters:

xares - An XAResource object

Returns:

True if same RM instance, otherwise false.

Throws:

javax.transaction.xa.XAException - XA protocol error

prepare

public int prepare(javax.transaction.xa.Xid xid)
            throws javax.transaction.xa.XAException

Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.

Specified by:

prepare in interface javax.transaction.xa.XAResource

Parameters:

xid - transaction xid

Throws:

javax.transaction.xa.XAException - XA protocol error

recover

public javax.transaction.xa.Xid[] recover(int flag)
                                   throws javax.transaction.xa.XAException

Obtain a list of prepared transaction branches from a resource manager.

Specified by:

recover in interface javax.transaction.xa.XAResource

Returns:

an array of transaction Xids

Throws:

javax.transaction.xa.XAException - XA protocol error

rollback

public void rollback(javax.transaction.xa.Xid xid)
              throws javax.transaction.xa.XAException

Inform the resource manager to roll back work done on behalf of a transaction branch

Specified by:

rollback in interface javax.transaction.xa.XAResource

Parameters:

xid - transaction xid

Throws:

javax.transaction.xa.XAException - XA protocol error

setTransactionTimeout

public boolean setTransactionTimeout(int seconds)
                              throws javax.transaction.xa.XAException

Set the current transaction timeout value for this XAResource instance.

Specified by:

setTransactionTimeout in interface javax.transaction.xa.XAResource

Parameters:

seconds - timeout value, in seconds.

Returns:

always true

Throws:

javax.transaction.xa.XAException - XA protocol error

start

public void start(javax.transaction.xa.Xid xid,
                  int flags)
           throws javax.transaction.xa.XAException

Start work on behalf of a transaction branch specified in xid

Specified by:

start in interface javax.transaction.xa.XAResource

Parameters:

xid - transaction xid

Throws:

javax.transaction.xa.XAException - XA protocol error

getXAResource

public javax.transaction.xa.XAResource getXAResource()
                                              throws java.sql.SQLException

Return an XA resource to the caller.

Specified by:

getXAResource in interface javax.sql.XAConnection

Returns:

The XAResource

Throws:

java.sql.SQLException - - if a database-access error occurs

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

psNumber

public int psNumber()

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Create an object handle for a database connection.

Specified by:

getConnection in interface javax.sql.PooledConnection

Throws:

java.sql.SQLException - - if a database-access error occurs

close

public void close()
           throws java.sql.SQLException

Close the database connection.

Specified by:

close in interface javax.sql.PooledConnection

Throws:

java.sql.SQLException - - if a database-access error occurs

addConnectionEventListener

public void addConnectionEventListener(javax.sql.ConnectionEventListener listener)

Add an event listener.

Specified by:

addConnectionEventListener in interface javax.sql.PooledConnection

Parameters:

listener - event listener

removeConnectionEventListener

public void removeConnectionEventListener(javax.sql.ConnectionEventListener listener)

Remove an event listener.

Specified by:

removeConnectionEventListener in interface javax.sql.PooledConnection

Parameters:

listener - event listener

enlistConnection

public void enlistConnection(javax.transaction.Transaction transaction)
                      throws javax.transaction.SystemException

implementation of resource manager event

Specified by:

enlistConnection in interface org.objectweb.transaction.jta.ResourceManagerEvent

Throws:

javax.transaction.SystemException

beforeCompletion

public void beforeCompletion()

synchronization implementation

Specified by:

beforeCompletion in interface javax.transaction.Synchronization

afterCompletion

public void afterCompletion(int status)

synchronization implementation

Specified by:

afterCompletion in interface javax.transaction.Synchronization

isAged

public boolean isAged()

Returns:

true if connection max age has expired

isOpen

public boolean isOpen()

Returns:

true if connection is still open

getOpenCount

public int getOpenCount()

Returns:

open count

inactive

public boolean inactive()

Check if the connection has been unused for too long time. This occurs usually when the caller forgot to call close().

Returns:

true if open time has been reached, and not involved in a tx.

isClosed

public boolean isClosed()

Returns:

true if connection is closed

hold

public void hold()

Notify as opened

release

public boolean release()

notify as closed

Returns:

true if normal close.

setTx

public void setTx(javax.transaction.Transaction tx)

Set the associated transaction

Parameters:

tx - Transaction

getTx

public javax.transaction.Transaction getTx()

Returns:

the Transaction

isRME

public boolean isRME()

Returns:

true if registered as RME

setRME

public void setRME(boolean rme)

set/unset as RME

remove

public void remove()

remove this item, ignoring exception on close.

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency)
                                            throws java.sql.SQLException

Try to find a PreparedStatement in the pool

Throws:

java.sql.SQLException

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql)
                                            throws java.sql.SQLException

Try to find a PreparedStatement in the pool

Throws:

java.sql.SQLException

notifyPsClose

public void notifyPsClose(JStatement ps)

A PreparedStatement has been logically closed.

Returns:

getRMID

public java.lang.String getRMID()

notifyClose

public void notifyClose()

notifyError

public void notifyError(java.sql.SQLException ex)