Package org.apache.activemq.artemis.core.transaction.impl

Class TransactionImpl

java.lang.Object

org.apache.activemq.artemis.core.transaction.impl.TransactionImpl

All Implemented Interfaces:

Transaction

Direct Known Subclasses:

BindingsTransactionImpl

public class TransactionImpl
extends Object
implements Transaction

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.activemq.artemis.core.transaction.Transaction

Transaction.State

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	containsPersistent
protected final long	id
protected Transaction.State	state
protected final StorageManager	storageManager
protected final Xid	xid

Constructor Summary

Constructors

Constructor	Description
TransactionImpl(long id, Xid xid, StorageManager storageManager)
TransactionImpl(Xid xid, StorageManager storageManager, int timeoutSeconds)
TransactionImpl(StorageManager storageManager)
TransactionImpl(StorageManager storageManager, int timeoutSeconds)

Method Summary

Modifier and Type	Method	Description
void	addOperation(TransactionOperation operation)
protected void	afterCommit(List<TransactionOperation> operationsToComplete)
void	afterStore(TransactionOperation sync)	This is an operation that will be called right after the storage is completed. addOperation could only happen after paging and replication, while these operations will just be about the storage
void	afterWired(Runnable callback)
void	commit()
void	commit(boolean onePhase)
RefsOperation	createRefsOperation(Queue queue, AckReason reason)
void	delay()	Calling this will defer the storage of the commit or prepare until delayDone is called.
void	delayDone()	This is to be called when the delay portion is done.
protected void	doCommit()
protected void	doRollback()
List<TransactionOperation>	getAllOperations()
long	getCreateTime()
long	getID()
int	getPendingDelay()
Object	getProperty(int index)
Object	getProtocolData()
protected OperationConsistencyLevel	getRequiredConsistency()
Transaction.State	getState()
Xid	getXid()
boolean	hasTimedOut()	To validate if the Transaction had previously timed out.
boolean	hasTimedOut(long currentTime, int defaultTimeout)
boolean	isAsync()
boolean	isContainsPersistent()
boolean	isEffective()
void	markAsRollbackOnly(ActiveMQException exception)
void	prepare()
void	putProperty(int index, Object property)
void	resume()
void	rollback()
TransactionImpl	setAsync(boolean async)	To be used on control transactions that are meant as internal and don't really require a hard sync.
void	setContainsPersistent()
void	setProtocolData(Object protocolData)	Protocol managers can use this field to store any object needed.
void	setState(Transaction.State state)
void	setTimeout(int timeout)
void	suspend()
String	toString()
boolean	tryRollback()	In a ServerSession failure scenario,\ we may try to rollback, however only if it's not prepared.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.transaction.Transaction

isAllowPageTransaction

Field Details

storageManager

protected final StorageManager storageManager

xid

protected final Xid xid

id

protected final long id

state

protected volatile Transaction.State state

containsPersistent

protected volatile boolean containsPersistent

Constructor Details

TransactionImpl

public TransactionImpl(StorageManager storageManager,
 int timeoutSeconds)

TransactionImpl

public TransactionImpl(StorageManager storageManager)

TransactionImpl

public TransactionImpl(Xid xid,
 StorageManager storageManager,
 int timeoutSeconds)

TransactionImpl

public TransactionImpl(long id,
 Xid xid,
 StorageManager storageManager)

Method Details

isAsync

public boolean isAsync()

Specified by:

isAsync in interface Transaction

setAsync

public TransactionImpl setAsync(boolean async)

Description copied from interface: Transaction

To be used on control transactions that are meant as internal and don't really require a hard sync.

Specified by:

setAsync in interface Transaction

getProtocolData

public Object getProtocolData()

Specified by:

getProtocolData in interface Transaction

setProtocolData

public void setProtocolData(Object protocolData)

Description copied from interface: Transaction

Protocol managers can use this field to store any object needed. An example would be the Session used by the transaction on openwire

Specified by:

setProtocolData in interface Transaction

isEffective

public boolean isEffective()

Specified by:

isEffective in interface Transaction

setContainsPersistent

public void setContainsPersistent()

Specified by:

setContainsPersistent in interface Transaction

isContainsPersistent

public boolean isContainsPersistent()

Specified by:

isContainsPersistent in interface Transaction

setTimeout

public void setTimeout(int timeout)

Specified by:

setTimeout in interface Transaction

createRefsOperation

public RefsOperation createRefsOperation(Queue queue,
 AckReason reason)

Specified by:

createRefsOperation in interface Transaction

getID

public long getID()

Specified by:

getID in interface Transaction

getCreateTime

public long getCreateTime()

Specified by:

getCreateTime in interface Transaction

hasTimedOut

public boolean hasTimedOut(long currentTime,
 int defaultTimeout)

Specified by:

hasTimedOut in interface Transaction

hasTimedOut

public boolean hasTimedOut()

Description copied from interface: Transaction

To validate if the Transaction had previously timed out. This is to check the reason why a TX has been rolled back.

Specified by:

hasTimedOut in interface Transaction

prepare

public void prepare()
             throws Exception

Specified by:

prepare in interface Transaction

Throws:

Exception

commit

public void commit()
            throws Exception

Specified by:

commit in interface Transaction

Throws:

Exception

afterWired

public void afterWired(Runnable callback)

Specified by:

afterWired in interface Transaction

getRequiredConsistency

protected OperationConsistencyLevel getRequiredConsistency()

commit

public void commit(boolean onePhase)
            throws Exception

Specified by:

commit in interface Transaction

Throws:

Exception

doCommit

protected void doCommit()
                 throws Exception

Throws:

Exception

tryRollback

public boolean tryRollback()

Description copied from interface: Transaction

In a ServerSession failure scenario,\ we may try to rollback, however only if it's not prepared. In case it's prepared, we will just let it be and let the transaction manager to deal with it

Specified by:

tryRollback in interface Transaction

rollback

public void rollback()
              throws Exception

Specified by:

rollback in interface Transaction

Throws:

Exception

suspend

public void suspend()

Specified by:

suspend in interface Transaction

resume

public void resume()

Specified by:

resume in interface Transaction

getState

public Transaction.State getState()

Specified by:

getState in interface Transaction

setState

public void setState(Transaction.State state)

Specified by:

setState in interface Transaction

getXid

public Xid getXid()

Specified by:

getXid in interface Transaction

markAsRollbackOnly

public void markAsRollbackOnly(ActiveMQException exception)

Specified by:

markAsRollbackOnly in interface Transaction

delay

public void delay()

Description copied from interface: Transaction

Calling this will defer the storage of the commit or prepare until delayDone is called.

Specified by:

delay in interface Transaction

delayDone

public void delayDone()

Description copied from interface: Transaction

This is to be called when the delay portion is done.

Specified by:

delayDone in interface Transaction

getPendingDelay

public int getPendingDelay()

addOperation

public void addOperation(TransactionOperation operation)

Specified by:

addOperation in interface Transaction

afterStore

public void afterStore(TransactionOperation sync)

Description copied from interface: Transaction

This is an operation that will be called right after the storage is completed. addOperation could only happen after paging and replication, while these operations will just be about the storage

Specified by:

afterStore in interface Transaction

getAllOperations

public List<TransactionOperation> getAllOperations()

Specified by:

getAllOperations in interface Transaction

putProperty

public void putProperty(int index,
 Object property)

Specified by:

putProperty in interface Transaction

getProperty

public Object getProperty(int index)

Specified by:

getProperty in interface Transaction

doRollback

protected void doRollback()
                   throws Exception

Throws:

Exception

afterCommit

protected void afterCommit(List<TransactionOperation> operationsToComplete)

toString

public String toString()

Overrides:

toString in class Object