Top Description Fields Constructors Methods
net.sf.ehcache.transaction

public Class TransactionIDFactoryImpl

extends AbstractTransactionIDFactory
Class Inheritance
Imports
java.util.concurrent.ConcurrentHashMap, .ConcurrentMap, net.sf.ehcache.Ehcache, net.sf.ehcache.transaction.xa.XidTransactionID, .XidTransactionIDImpl, javax.transaction.xa.Xid
A TransactionIDFactory implementation with uniqueness across a single JVM
Author
Ludovic Orban

Field Summary

Modifier and TypeField and Description
private final ConcurrentMap<TransactionID, Decision>
transactionStates

Constructor Summary

AccessConstructor and Description
public
TransactionIDFactoryImpl()

Method Summary

Modifier and TypeMethod and Description
public TransactionID
createTransactionID()

Implements net.sf.ehcache.transaction.TransactionIDFactory.createTransactionID.

Create a unique transaction ID
public XidTransactionID
createXidTransactionID(Xid
the XID
xid, Ehcache cache)

Implements net.sf.ehcache.transaction.TransactionIDFactory.createXidTransactionID.

Create a transaction ID based on a XID for uniqueness
protected ConcurrentMap<TransactionID, Decision>
getTransactionStates()

Implements abstract net.sf.ehcache.transaction.AbstractTransactionIDFactory.getTransactionStates.

Return the map of transaction states.
public boolean
isExpired(TransactionID transactionID)

Implements net.sf.ehcache.transaction.TransactionIDFactory.isExpired.

Check if the transaction ID expired, ie: that the transaction died abnormally
public Boolean
isPersistent()

Implements net.sf.ehcache.transaction.TransactionIDFactory.isPersistent.

Return true if the factory state is persistent (survives JVM restart).
public TransactionID
restoreTransactionID(TransactionIDSerializedForm
the TransactionID serialized form
serializedForm)

Implements net.sf.ehcache.transaction.TransactionIDFactory.restoreTransactionID.

Restore a transaction ID from its serialized form
public XidTransactionID
restoreXidTransactionID(XidTransactionIDSerializedForm
the XidTransactionID serialized form
serializedForm)

Implements net.sf.ehcache.transaction.TransactionIDFactory.restoreXidTransactionID.

Restore a XID transaction ID from its serialized form
Inherited from net.sf.ehcache.transaction.AbstractTransactionIDFactory:
cleargetAllTransactionIDsgetAllXidTransactionIDsForisDecisionCommitmarkForCommitmarkForRollback

Field Detail

transactionStatesback to summary
private final ConcurrentMap<TransactionID, Decision> transactionStates

Constructor Detail

TransactionIDFactoryImplback to summary
public TransactionIDFactoryImpl()

Method Detail

createTransactionIDback to summary
public TransactionID createTransactionID()

Implements net.sf.ehcache.transaction.TransactionIDFactory.createTransactionID.

Doc from net.sf.ehcache.transaction.TransactionIDFactory.createTransactionID.

Create a unique transaction ID

Returns:TransactionID

a transaction ID

createXidTransactionIDback to summary
public XidTransactionID createXidTransactionID(Xid xid, Ehcache cache)

Implements net.sf.ehcache.transaction.TransactionIDFactory.createXidTransactionID.

Doc from net.sf.ehcache.transaction.TransactionIDFactory.createXidTransactionID.

Create a transaction ID based on a XID for uniqueness

Parameters
xid:Xid

the XID

Returns:XidTransactionID

a transaction ID

getTransactionStatesback to summary
protected ConcurrentMap<TransactionID, Decision> getTransactionStates()

Implements abstract net.sf.ehcache.transaction.AbstractTransactionIDFactory.getTransactionStates.

Doc from net.sf.ehcache.transaction.AbstractTransactionIDFactory.getTransactionStates.

Return the map of transaction states.

Returns:ConcurrentMap<TransactionID, Decision>

the map of transaction states

Annotations
@Override
isExpiredback to summary
public boolean isExpired(TransactionID transactionID)

Implements net.sf.ehcache.transaction.TransactionIDFactory.isExpired.

Doc from net.sf.ehcache.transaction.TransactionIDFactory.isExpired.

Check if the transaction ID expired, ie: that the transaction died abnormally

Returns:boolean

true if the transaction ID expired and should be cleaned up, false otherwise

Annotations
@Override
isPersistentback to summary
public Boolean isPersistent()

Implements net.sf.ehcache.transaction.TransactionIDFactory.isPersistent.

Doc from net.sf.ehcache.transaction.TransactionIDFactory.isPersistent.

Return true if the factory state is persistent (survives JVM restart).

This is a tri-state return:

  • Boolean.TRUE : persistent
  • Boolean.FALSE : not persistent
  • null : not yet determined
Returns:Boolean

true is state is persistent

Annotations
@Override
restoreTransactionIDback to summary
public TransactionID restoreTransactionID(TransactionIDSerializedForm serializedForm)

Implements net.sf.ehcache.transaction.TransactionIDFactory.restoreTransactionID.

Doc from net.sf.ehcache.transaction.TransactionIDFactory.restoreTransactionID.

Restore a transaction ID from its serialized form

Parameters
serializedForm:TransactionIDSerializedForm

the TransactionID serialized form

Returns:TransactionID

the restored TransactionID

restoreXidTransactionIDback to summary
public XidTransactionID restoreXidTransactionID(XidTransactionIDSerializedForm serializedForm)

Implements net.sf.ehcache.transaction.TransactionIDFactory.restoreXidTransactionID.

Doc from net.sf.ehcache.transaction.TransactionIDFactory.restoreXidTransactionID.

Restore a XID transaction ID from its serialized form

Parameters
serializedForm:XidTransactionIDSerializedForm

the XidTransactionID serialized form

Returns:XidTransactionID

the restored XidTransactionID