bitronix.tm.resource.ehcache

Class EhCacheXAResourceHolder

java.lang.Object

bitronix.tm.resource.common.AbstractXAStatefulHolder

bitronix.tm.resource.common.AbstractXAResourceHolder

bitronix.tm.resource.ehcache.EhCacheXAResourceHolder

All Implemented Interfaces:

XAResourceHolder, XAStatefulHolder

public class EhCacheXAResourceHolder
extends AbstractXAResourceHolder

Ehcache implementation of BTM's XAResourceHolder.

Copyright 2003-2010 Terracotta, Inc.

Author:

lorban

Field Summary

Fields inherited from interface bitronix.tm.resource.common.XAStatefulHolder

STATE_ACCESSIBLE, STATE_CLOSED, STATE_IN_POOL, STATE_NOT_ACCESSIBLE

Constructor Summary

Constructors

Constructor and Description
EhCacheXAResourceHolder(javax.transaction.xa.XAResource resource, ResourceBean bean) Create a new EhCacheXAResourceHolder for a particular XAResource

Method Summary

Modifier and Type	Method and Description
void	close() Close the physical connection that this XAStatefulHolder represents.
java.lang.Object	getConnectionHandle() Create a disposable handler used to drive a pooled instance of XAStatefulHolder.
java.util.Date	getLastReleaseDate() Get the date at which this object was last released to the pool.
ResourceBean	getResourceBean() Get the ResourceBean which created this XAResourceHolder.
javax.transaction.xa.XAResource	getXAResource() Get the vendor's XAResource implementation of the wrapped resource.
java.util.List<XAResourceHolder>	getXAResourceHolders() Get the list of XAResourceHolders created by this XAStatefulHolder that are still open.

Methods inherited from class bitronix.tm.resource.common.AbstractXAResourceHolder

getXAResourceHolderStateGtrids, getXAResourceHolderStatesForGtrid, hasStateForXAResource, isParticipatingInActiveGlobalTransaction, putXAResourceHolderState, removeXAResourceHolderState

Methods inherited from class bitronix.tm.resource.common.AbstractXAStatefulHolder

addStateChangeEventListener, getState, removeStateChangeEventListener, setState

Methods inherited from class java.lang.Object

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

Methods inherited from interface bitronix.tm.resource.common.XAStatefulHolder

addStateChangeEventListener, getState, removeStateChangeEventListener, setState

Constructor Detail

EhCacheXAResourceHolder

public EhCacheXAResourceHolder(javax.transaction.xa.XAResource resource,
                               ResourceBean bean)

Create a new EhCacheXAResourceHolder for a particular XAResource

Parameters:

resource - the required XAResource

bean - the required ResourceBean

Method Detail

getXAResource

public javax.transaction.xa.XAResource getXAResource()

Get the vendor's XAResource implementation of the wrapped resource.

Returns:

the vendor's XAResource implementation.

getResourceBean

public ResourceBean getResourceBean()

Get the ResourceBean which created this XAResourceHolder.

Returns:

the ResourceBean which created this XAResourceHolder.

close

public void close()
           throws java.lang.Exception

Close the physical connection that this XAStatefulHolder represents.

Throws:

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

getConnectionHandle

public java.lang.Object getConnectionHandle()
                                     throws java.lang.Exception

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

This method is thread-safe.

Returns:

a resource-specific disaposable connection object.

Throws:

java.lang.Exception - a resource-specific exception thrown when the disaposable connection cannot be created.

getLastReleaseDate

public java.util.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.

getXAResourceHolders

public java.util.List<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.