Top Description Methods
net.sf.ehcache.transaction

public Interface TransactionIDFactory

Known Direct Implementers
net.sf.ehcache.transaction.AbstractTransactionIDFactory, net.sf.ehcache.transaction.DelegatingTransactionIDFactory
Imports
java.util.Set, net.sf.ehcache.Ehcache, net.sf.ehcache.transaction.xa.XidTransactionID, javax.transaction.xa.Xid
A factory for transaction IDs. Generated transaction ID's must be unique to the entire cluster-wide CacheManager.
Author
Ludovic Orban

Method Summary

Modifier and TypeMethod and Description
public void
clear(TransactionID
transaction to be cleared
transactionID)

Clear this transaction's state representation.

public TransactionID

Returns:

a transaction ID
createTransactionID()

Create a unique transaction ID

public XidTransactionID

Returns:

a transaction ID
createXidTransactionID(Xid
the XID
xid, Ehcache cache)

Create a transaction ID based on a XID for uniqueness

public Set<TransactionID>

Returns:

the set of transactions
getAllTransactionIDs()

Get the set of all known transactions.

public Set<XidTransactionID>

Returns:

the set of transactions
getAllXidTransactionIDsFor(Ehcache cache)

Get the set of all XID transactions of a cache.

public boolean

Returns:

true if the transaction should be committed
isDecisionCommit(TransactionID
transaction to be queried
transactionID)

Check if the given transaction should be committed or not

public boolean

Returns:

true if the transaction ID expired and should be cleaned up, false otherwise
isExpired(TransactionID transactionID)

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

public Boolean

Returns:

true is state is persistent
isPersistent()

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

public void
markForCommit(TransactionID
transaction to be marked
transactionID)

Mark that this transaction's decision is commit

public void
markForRollback(XidTransactionID transactionID)

Mark this transaction ID for rollback

public TransactionID

Returns:

the restored TransactionID
restoreTransactionID(TransactionIDSerializedForm
the TransactionID serialized form
serializedForm)

Restore a transaction ID from its serialized form

public XidTransactionID

Returns:

the restored XidTransactionID
restoreXidTransactionID(XidTransactionIDSerializedForm
the XidTransactionID serialized form
serializedForm)

Restore a XID transaction ID from its serialized form

Method Detail

clearback to summary
public void clear(TransactionID transactionID)

Clear this transaction's state representation.

Parameters
transactionID:TransactionID

transaction to be cleared

createTransactionIDback to summary
public TransactionID createTransactionID()

Create a unique transaction ID

Returns:TransactionID

a transaction ID

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

Create a transaction ID based on a XID for uniqueness

Parameters
xid:Xid

the XID

Returns:XidTransactionID

a transaction ID

getAllTransactionIDsback to summary
public Set<TransactionID> getAllTransactionIDs()

Get the set of all known transactions.

Returns:Set<TransactionID>

the set of transactions

getAllXidTransactionIDsForback to summary
public Set<XidTransactionID> getAllXidTransactionIDsFor(Ehcache cache)

Get the set of all XID transactions of a cache.

Returns:Set<XidTransactionID>

the set of transactions

isDecisionCommitback to summary
public boolean isDecisionCommit(TransactionID transactionID)

Check if the given transaction should be committed or not

Parameters
transactionID:TransactionID

transaction to be queried

Returns:boolean

true if the transaction should be committed

isExpiredback to summary
public boolean isExpired(TransactionID transactionID)

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

isPersistentback to summary
public Boolean 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

markForCommitback to summary
public void markForCommit(TransactionID transactionID)

Mark that this transaction's decision is commit

Parameters
transactionID:TransactionID

transaction to be marked

markForRollbackback to summary
public void markForRollback(XidTransactionID transactionID)

Mark this transaction ID for rollback

restoreTransactionIDback to summary
public TransactionID restoreTransactionID(TransactionIDSerializedForm serializedForm)

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)

Restore a XID transaction ID from its serialized form

Parameters
serializedForm:XidTransactionIDSerializedForm

the XidTransactionID serialized form

Returns:XidTransactionID

the restored XidTransactionID