org.jboss.jca.core.connectionmanager.listener

Class AbstractConnectionListener

java.lang.Object

org.jboss.jca.core.connectionmanager.listener.AbstractConnectionListener

All Implemented Interfaces:

Comparable, EventListener, javax.resource.spi.ConnectionEventListener, org.jboss.jca.core.api.connectionmanager.listener.ConnectionListener

Direct Known Subclasses:

NoTxConnectionListener, TxConnectionListener

public abstract class AbstractConnectionListener
extends Object
implements ConnectionListener

Abstract implementation of the ConnectionListener interface contract.

Author:

Gurkan Erdogdu, Jesper Pedersen

Field Summary

Fields

Modifier and Type	Field and Description
protected CopyOnWriteArraySet<Object>	connectionHandles Connection handles
protected boolean	trace Log trace

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConnectionListener(ConnectionManager cm, javax.resource.spi.ManagedConnection managedConnection, Pool pool, ManagedConnectionPool mcp, org.jboss.jca.common.api.metadata.common.FlushStrategy flushStrategy) Creates a new instance of the listener that is responsible for tracking the owned connection instance.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Object o) Compare
void	connectionClosed(javax.resource.spi.ConnectionEvent event)
void	connectionErrorOccurred(javax.resource.spi.ConnectionEvent event)
boolean	controls(javax.resource.spi.ManagedConnection mc, Object connection) Controls the managed connection / connection pair
void	delist() Delist the managed connection
void	dissociate() Dissociate the connection listener
void	enlist() Enlist the managed connection
protected org.jboss.jca.core.api.connectionmanager.ccm.CachedConnectionManager	getCachedConnectionManager() Gets cached connection manager
protected ConnectionManager	getConnectionManager() Gets connection manager.
long	getLastUsedTime() Retrieve the last time this connection was used.
long	getLastValidatedTime() Retrieve the last time this connection was validated.
protected abstract CoreLogger	getLogger() Get the logger
javax.resource.spi.ManagedConnection	getManagedConnection() Retrieve the managed connection for this listener.
ManagedConnectionPool	getManagedConnectionPool() Get the managed connection pool
int	getNumberOfConnections() Get number of connection handles
Pool	getPool() Retrieve the pool for this listener.
ConnectionState	getState() Retrieve the state of this connection.
boolean	isEnlisted() Is enlisted
boolean	isManagedConnectionFree() Is the managed connection free?
boolean	isTimedOut(long timeout) Has the connection timed out?
boolean	isTrackByTx() Get whether the listener is track by transaction
void	localTransactionCommitted(javax.resource.spi.ConnectionEvent event)
void	localTransactionRolledback(javax.resource.spi.ConnectionEvent event)
void	localTransactionStarted(javax.resource.spi.ConnectionEvent event)
void	registerConnection(Object handle) Register a new connection
void	setLastValidatedTime(long lastValidated) Set the last time, in milliseconds, that this connection was validated.
void	setState(ConnectionState newState) Set the state of this connection.
void	setTrackByTx(boolean trackByTx) Set whether the listener is track by transaction
boolean	supportsLazyAssociation() Supports lazy association
boolean	supportsLazyEnlistment() Supports lazy enlistment
void	tidyup() Tidyup
String	toString()
protected void	toString(StringBuffer buffer) Add specific properties.
void	unregisterConnection(Object handle) Unregister a connection
void	unregisterConnections() Unregister connections.
void	used() Mark the connection as used

Methods inherited from class java.lang.Object

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

Field Detail

trace

protected boolean trace

Log trace

connectionHandles

protected CopyOnWriteArraySet<Object> connectionHandles

Connection handles

Constructor Detail

AbstractConnectionListener

protected AbstractConnectionListener(ConnectionManager cm,
                          javax.resource.spi.ManagedConnection managedConnection,
                          Pool pool,
                          ManagedConnectionPool mcp,
                          org.jboss.jca.common.api.metadata.common.FlushStrategy flushStrategy)

Creates a new instance of the listener that is responsible for tracking the owned connection instance.

Parameters:

cm - connection manager

managedConnection - managed connection

pool - pool

mcp - managed connection pool

flushStrategy - flushStrategy

Method Detail

getCachedConnectionManager

protected org.jboss.jca.core.api.connectionmanager.ccm.CachedConnectionManager getCachedConnectionManager()

Gets cached connection manager

Returns:

cached connection manager

getConnectionManager

protected ConnectionManager getConnectionManager()

Gets connection manager.

Returns:

connection manager

getLogger

protected abstract CoreLogger getLogger()

Get the logger

Returns:

The value

getNumberOfConnections

public int getNumberOfConnections()

Get number of connection handles

Returns:

The value

isEnlisted

public boolean isEnlisted()

Is enlisted

Returns:

True if enlisted, otherwise false

delist

public void delist()
            throws javax.resource.ResourceException

Delist the managed connection

Throws:

javax.resource.ResourceException - if exception occurs

enlist

public void enlist()
            throws SystemException

Enlist the managed connection

Throws:

SystemException - for errors

getManagedConnectionPool

public ManagedConnectionPool getManagedConnectionPool()

Get the managed connection pool

Returns:

The value

getLastValidatedTime

public long getLastValidatedTime()

Retrieve the last time this connection was validated.

Returns:

the last time the connection was validated

getLastUsedTime

public long getLastUsedTime()

Retrieve the last time this connection was used.

Returns:

the last time the connection was used

getManagedConnection

public javax.resource.spi.ManagedConnection getManagedConnection()

Retrieve the managed connection for this listener.

Specified by:

getManagedConnection in interface org.jboss.jca.core.api.connectionmanager.listener.ConnectionListener

Returns:

the managed connection

getPool

public Pool getPool()

Retrieve the pool for this listener.

Returns:

the pool

getState

public ConnectionState getState()

Retrieve the state of this connection.

Returns:

the state

isManagedConnectionFree

public boolean isManagedConnectionFree()

Is the managed connection free?

Returns:

true when it is free

isTimedOut

public boolean isTimedOut(long timeout)

Has the connection timed out?

Parameters:

timeout - the timeout

Returns:

true for timed out, false otherwise

isTrackByTx

public boolean isTrackByTx()

Get whether the listener is track by transaction

Returns:

true for track by transaction, false otherwise

registerConnection

public void registerConnection(Object handle)

Register a new connection

Parameters:

handle - the connection handle

setLastValidatedTime

public void setLastValidatedTime(long lastValidated)

Set the last time, in milliseconds, that this connection was validated.

Parameters:

lastValidated - the last time the connection was validated in milliseconds.

setState

public void setState(ConnectionState newState)

Set the state of this connection.

Parameters:

newState - new state

setTrackByTx

public void setTrackByTx(boolean trackByTx)

Set whether the listener is track by transaction

Parameters:

trackByTx - true for track by transaction, false otherwise

tidyup

public void tidyup()
            throws javax.resource.ResourceException

Tidyup

Invoked just before returning the connection to the pool when the connection is not being destroyed.

Throws:

javax.resource.ResourceException - for any error

unregisterConnection

public void unregisterConnection(Object handle)

Unregister a connection

Parameters:

handle - the connection handle

unregisterConnections

public void unregisterConnections()

Unregister connections.

used

public void used()

Mark the connection as used

connectionClosed

public void connectionClosed(javax.resource.spi.ConnectionEvent event)

Specified by:

connectionClosed in interface javax.resource.spi.ConnectionEventListener

connectionErrorOccurred

public void connectionErrorOccurred(javax.resource.spi.ConnectionEvent event)

Specified by:

connectionErrorOccurred in interface javax.resource.spi.ConnectionEventListener

controls

public boolean controls(javax.resource.spi.ManagedConnection mc,
               Object connection)

Controls the managed connection / connection pair

Parameters:

mc - The managed connection

connection - The connection; optional

Returns:

True if the connection listener controls the pair, otherwise false

dissociate

public void dissociate()
                throws javax.resource.ResourceException

Dissociate the connection listener

Throws:

javax.resource.ResourceException - if exception occurs

supportsLazyAssociation

public boolean supportsLazyAssociation()

Supports lazy association

Returns:

True if supported, otherwise false

supportsLazyEnlistment

public boolean supportsLazyEnlistment()

Supports lazy enlistment

Returns:

True if supported, otherwise false

localTransactionCommitted

public void localTransactionCommitted(javax.resource.spi.ConnectionEvent event)

Specified by:

localTransactionCommitted in interface javax.resource.spi.ConnectionEventListener

localTransactionRolledback

public void localTransactionRolledback(javax.resource.spi.ConnectionEvent event)

Specified by:

localTransactionRolledback in interface javax.resource.spi.ConnectionEventListener

localTransactionStarted

public void localTransactionStarted(javax.resource.spi.ConnectionEvent event)

Specified by:

localTransactionStarted in interface javax.resource.spi.ConnectionEventListener

compareTo

public int compareTo(Object o)

Compare

Specified by:

compareTo in interface Comparable

Parameters:

o - The other object

Returns:

0 if equal; -1 if less than based on lastUse; otherwise 1

toString

public String toString()

Overrides:

toString in class Object

toString

protected void toString(StringBuffer buffer)

Add specific properties.

Parameters:

buffer - buffer instance