Package org.objectweb.joram.client.connector

Class ManagedConnectionImpl

java.lang.Object

org.objectweb.joram.client.connector.ManagedConnectionImpl

All Implemented Interfaces:

ExceptionListener, LocalTransaction, ManagedConnection

public class ManagedConnectionImpl
extends Object
implements ManagedConnection, LocalTransaction, ExceptionListener

A ManagedConnectionImpl instance wraps a physical connection to an underlying JORAM server, and provides "handles" for handling this physical connection.

Field Summary

Fields

Modifier and Type	Field	Description
private XAConnection	cnx	Physical connection to the JORAM server.
(package private) ConnectionRequestInfo	cxRequest	only used for reconnection
private static boolean	DEBUG
private Vector<OutboundConnection>	handles	Vector of connection handles.
private int	hashCode	hashCode
(package private) String	hostName	Underlying JORAM server host name.
private Vector<ConnectionEventListener>	listeners	Vector of condition event listeners.
private Object	lock	Use for reconnection synchronization
private Object	lockForExc
private static Logger	logger
(package private) ManagedConnectionFactoryImpl	mcf	Ref to the managed connection factory (use to reconnect)
private ManagedConnectionMetaDataImpl	metaData	Connection meta data.
(package private) String	mode	Messaging mode (PTP or PubSub or Unified).
private PrintWriter	out	Out stream for error logging and tracing.
private JoramResourceAdapter	ra	Central adapter authority.
(package private) int	serverPort	Underlying JORAM server port number.
private Session	session	Unique session for the use of managed components, involved in local or distributed transactions.
private boolean	startedLocalTx	true if a local transaction has been started.
(package private) Subject	subject	only used for reconnection
private long	timeWaitReconnect	The waiting time in ms for reconnection.
(package private) String	userName	User identification.
private boolean	valid	true if the connection is valid.

Constructor Summary

Constructors

Constructor	Description
ManagedConnectionImpl(JoramResourceAdapter ra, ManagedConnectionFactoryImpl mcf, XAConnection cnx, String hostName, int serverPort, String userName)	Creates a ManagedConnectionImpl instance wrapping a physical connection to the underlying JORAM server.

Method Summary

Modifier and Type	Method	Description
void	addConnectionEventListener(ConnectionEventListener listener)	Adds a connection event listener.
void	associateConnection(Object connection)	Dissociates a given connection handle and associates it to this managed connection.
void	begin()	Notifies that the local transaction is beginning.
void	cleanup()	Remove the created handles and prepares the physical connection to be put back into a connection pool.
(package private) void	closeHandle(OutboundConnection handle)	Notifies of the closing of one of the connection handles.
void	commit()	Commits the local transaction.
void	destroy()	Destroys the physical connection to the underlying JORAM server.
boolean	equals(Object o)	Compares ManagedConnectionImpl instances according to their server and user identification parameters.
Object	getConnection(Subject subject, ConnectionRequestInfo cxRequestInfo)	Returns a new OutboundConnection instance for handling the physical connection.
LocalTransaction	getLocalTransaction()	Returns this managed connection instance as a LocalTransaction instance for managing local transactions.
PrintWriter	getLogWriter()	Gets the log writer for this ManagedConnectionImpl instance.
ManagedConnectionMetaData	getMetaData()	Returns the metadata information for the underlying JORAM server.
(package private) Session	getSession()
XAResource	getXAResource()	Provides a XAResource instance for managing distributed transactions.
int	hashCode()	Returns a code based on the JORAM server and user identification parameters.
(package private) boolean	isReconnected()
(package private) boolean	isValid()	Returns false if the wrapped physical connection has been lost or destroyed, true if it is still valid.
(package private) boolean	matches(String hostName, int serverPort, String userName, String mode)	Returns true if this managed connection matches given parameters.
void	onException(JMSException exc)	Notifies that the wrapped physical connection has been lost.
(package private) void	reconnect()
void	removeConnectionEventListener(ConnectionEventListener listener)	Removes a connection event listener.
void	rollback()	Rollsback the local transaction.
void	setLogWriter(PrintWriter out)	Sets the log writer for this ManagedConnectionImpl instance.
(package private) void	setSession(Session session)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

DEBUG

private static final boolean DEBUG

ra

private JoramResourceAdapter ra

Central adapter authority.

mcf

ManagedConnectionFactoryImpl mcf

Ref to the managed connection factory (use to reconnect)

cnx

private XAConnection cnx

Physical connection to the JORAM server.

handles

private Vector<OutboundConnection> handles

Vector of connection handles.

listeners

private Vector<ConnectionEventListener> listeners

Vector of condition event listeners.

startedLocalTx

private boolean startedLocalTx

true if a local transaction has been started.

metaData

private ManagedConnectionMetaDataImpl metaData

Connection meta data.

out

private PrintWriter out

Out stream for error logging and tracing.

valid

private boolean valid

true if the connection is valid.

hashCode

private int hashCode

hashCode

hostName

String hostName

Underlying JORAM server host name.

serverPort

int serverPort

Underlying JORAM server port number.

mode

String mode

Messaging mode (PTP or PubSub or Unified).

userName

String userName

User identification.

session

private Session session

Unique session for the use of managed components, involved in local or distributed transactions.

subject

Subject subject

only used for reconnection

cxRequest

ConnectionRequestInfo cxRequest

only used for reconnection

lock

private Object lock

Use for reconnection synchronization

timeWaitReconnect

private long timeWaitReconnect

The waiting time in ms for reconnection.

lockForExc

private Object lockForExc

Constructor Detail

ManagedConnectionImpl

ManagedConnectionImpl(JoramResourceAdapter ra,
                      ManagedConnectionFactoryImpl mcf,
                      XAConnection cnx,
                      String hostName,
                      int serverPort,
                      String userName)

Creates a ManagedConnectionImpl instance wrapping a physical connection to the underlying JORAM server.

Parameters:

ra - Central adapter authority.

mcf - The Managed Connection Factory

cnx - Physical connection to the JORAM server.

hostName - JORAM server host name.

serverPort - JORAM server port number.

userName - User identification.

Method Detail

getSession

final Session getSession()

setSession

final void setSession(Session session)

hashCode

public int hashCode()

Returns a code based on the JORAM server and user identification parameters.

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Compares ManagedConnectionImpl instances according to their server and user identification parameters.

Overrides:

equals in class Object

getConnection

public Object getConnection(Subject subject,
                            ConnectionRequestInfo cxRequestInfo)
                     throws ResourceException

Returns a new OutboundConnection instance for handling the physical connection.

Specified by:

getConnection in interface ManagedConnection

Throws:

CommException - If the wrapped physical connection is lost.

ResourceException

associateConnection

public void associateConnection(Object connection)
                         throws ResourceException

Dissociates a given connection handle and associates it to this managed connection.

Specified by:

associateConnection in interface ManagedConnection

Throws:

CommException - If the wrapped physical connection is lost.

ResourceException - If the provided handle is invalid.

addConnectionEventListener

public void addConnectionEventListener(ConnectionEventListener listener)

Adds a connection event listener.

Specified by:

addConnectionEventListener in interface ManagedConnection

removeConnectionEventListener

public void removeConnectionEventListener(ConnectionEventListener listener)

Removes a connection event listener.

Specified by:

removeConnectionEventListener in interface ManagedConnection

getXAResource

public XAResource getXAResource()
                         throws ResourceException

Provides a XAResource instance for managing distributed transactions.

Specified by:

getXAResource in interface ManagedConnection

Throws:

CommException - If the physical connection is lost.

IllegalStateException - If the managed connection is involved in a local transaction.

ResourceAdapterInternalException - If the XA resource can't be retrieved.

ResourceException

getLocalTransaction

public LocalTransaction getLocalTransaction()
                                     throws ResourceException

Returns this managed connection instance as a LocalTransaction instance for managing local transactions.

Specified by:

getLocalTransaction in interface ManagedConnection

Throws:

CommException - If the physical connection is lost.

IllegalStateException - If the managed connection is involved in a distributed transaction.

LocalTransactionException - If the LocalTransaction resource can't be created.

ResourceException

getMetaData

public ManagedConnectionMetaData getMetaData()
                                      throws ResourceException

Returns the metadata information for the underlying JORAM server.

Specified by:

getMetaData in interface ManagedConnection

Throws:

ResourceException - Never thrown.

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws ResourceException

Sets the log writer for this ManagedConnectionImpl instance.

Specified by:

setLogWriter in interface ManagedConnection

Throws:

ResourceException - Never thrown.

getLogWriter

public PrintWriter getLogWriter()
                         throws ResourceException

Gets the log writer for this ManagedConnectionImpl instance.

Specified by:

getLogWriter in interface ManagedConnection

Throws:

ResourceException - Never thrown.

cleanup

public void cleanup()
             throws ResourceException

Remove the created handles and prepares the physical connection to be put back into a connection pool.

Specified by:

cleanup in interface ManagedConnection

Throws:

ResourceException - Never thrown.

destroy

public void destroy()
             throws ResourceException

Destroys the physical connection to the underlying JORAM server.

Specified by:

destroy in interface ManagedConnection

Throws:

ResourceException - Never thrown.

onException

public void onException(JMSException exc)

Notifies that the wrapped physical connection has been lost.

Specified by:

onException in interface ExceptionListener

reconnect

void reconnect()

isReconnected

boolean isReconnected()

begin

public void begin()
           throws ResourceException

Notifies that the local transaction is beginning.

Specified by:

begin in interface LocalTransaction

Throws:

CommException - If the wrapped physical connection is lost.

LocalTransactionException - If a local transaction has already begun.

ResourceException

commit

public void commit()
            throws ResourceException

Commits the local transaction.

Specified by:

commit in interface LocalTransaction

Throws:

CommException - If the wrapped physical connection is lost.

LocalTransactionException - If the local transaction has not begun, or if the commit fails.

ResourceException

rollback

public void rollback()
              throws ResourceException

Rollsback the local transaction.

Specified by:

rollback in interface LocalTransaction

Throws:

CommException - If the wrapped physical connection is lost.

LocalTransactionException - If the local transaction has not begun, or if the rollback fails.

ResourceException

matches

boolean matches(String hostName,
                int serverPort,
                String userName,
                String mode)

Returns true if this managed connection matches given parameters.

isValid

boolean isValid()

Returns false if the wrapped physical connection has been lost or destroyed, true if it is still valid.

closeHandle

void closeHandle(OutboundConnection handle)

Notifies of the closing of one of the connection handles.