bitronix.tm.resource.common

Interface XAStatefulHolder<T extends XAStatefulHolder<T>>

All Known Subinterfaces:

XAResourceHolder<T>

All Known Implementing Classes:

AbstractXAResourceHolder, AbstractXAStatefulHolder, DualSessionWrapper, EhCacheXAResourceHolder, JdbcPooledConnection, JmsPooledConnection, RecoveryXAResourceHolder

public interface XAStatefulHolder<T extends XAStatefulHolder<T>>

Any pooled connection class must implement the XAStatefulHolder interface. It defines all the services that must be implemented by the connection as well as the pooling lifecycle states. Instances of this interface have to create and manage XAResourceHolders.

Author:

Ludovic Orban

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	XAStatefulHolder.State

Method Summary

Modifier and Type	Method and Description
void	addStateChangeEventListener(StateChangeListener<T> listener) Register an implementation of StateChangeListener.
void	close() Close the physical connection that this XAStatefulHolder represents.
Object	getConnectionHandle() Create a disposable handler used to drive a pooled instance of XAStatefulHolder.
Date	getCreationDate() Get the date at which this object was created in the pool.
Date	getLastReleaseDate() Get the date at which this object was last released to the pool.
XAStatefulHolder.State	getState() Get the current resource state.
List<? extends XAResourceHolder<? extends XAResourceHolder>>	getXAResourceHolders() Get the list of XAResourceHolders created by this XAStatefulHolder that are still open.
void	removeStateChangeEventListener(StateChangeListener<T> listener) Unregister an implementation of StateChangeListener.
void	setState(XAStatefulHolder.State state) Set the current resource state.

Method Detail

getState

XAStatefulHolder.State getState()

Get the current resource state.

This method is thread-safe.

Returns:

the current resource state.

setState

void setState(XAStatefulHolder.State state)

Set the current resource state.

This method is thread-safe.

Parameters:

state - the current resource state.

addStateChangeEventListener

void addStateChangeEventListener(StateChangeListener<T> listener)

Register an implementation of StateChangeListener.

Parameters:

listener - the StateChangeListener implementation to register.

removeStateChangeEventListener

void removeStateChangeEventListener(StateChangeListener<T> listener)

Unregister an implementation of StateChangeListener.

Parameters:

listener - the StateChangeListener implementation to unregister.

getXAResourceHolders

List<? extends XAResourceHolder<? extends XAResourceHolder>> getXAResourceHolders()

Get the list of XAResourceHolders created by this XAStatefulHolder that are still open.

This method is thread-safe.

Returns:

the list of XAResourceHolders created by this XAStatefulHolder that are still open.

getConnectionHandle

Object getConnectionHandle()
                    throws Exception

Create a disposable handler used to drive a pooled instance of XAStatefulHolder.

This method is thread-safe.

Returns:

a resource-specific disposable connection object.

Throws:

Exception - a resource-specific exception thrown when the disposable connection cannot be created.

close

void close()
    throws Exception

Close the physical connection that this XAStatefulHolder represents.

Throws:

Exception - a resource-specific exception thrown when there is an error closing the physical connection.

getLastReleaseDate

Date getLastReleaseDate()

Get the date at which this object was last released to the pool. This is required to check if it is eligible for discard when the containing pool needs to shrink.

Returns:

the date at which this object was last released to the pool or null if it never left the pool.

getCreationDate

Date getCreationDate()

Get the date at which this object was created in the pool.

Returns:

the date at which this object was created in the pool.