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

Interface Transaction

All Known Implementing Classes:

BindingsTransactionImpl, TransactionImpl

public interface Transaction

An ActiveMQ Artemis internal transaction

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Transaction.State

Method Summary

Modifier and Type	Method	Description
void	addOperation(TransactionOperation sync)
void	afterStore(TransactionOperation sync)	This is an operation that will be called right after the storage is completed.
void	commit()
void	commit(boolean onePhase)
RefsOperation	createRefsOperation(Queue queue, AckReason reason)
List<TransactionOperation>	getAllOperations()
long	getCreateTime()
long	getID()
Object	getProperty(int index)
Object	getProtocolData()
Transaction.State	getState()
Xid	getXid()
boolean	hasTimedOut()	To validate if the Transaction had previously timed out.
boolean	hasTimedOut(long currentTime, int defaultTimeout)
boolean	isContainsPersistent()
boolean	isEffective()
void	markAsRollbackOnly(ActiveMQException exception)
void	prepare()
void	putProperty(int index, Object property)
void	resume()
void	rollback()
void	setContainsPersistent()
void	setProtocolData(Object data)	Protocol managers can use this field to store any object needed.
void	setState(Transaction.State state)
void	setTimeout(int timeout)
void	suspend()
boolean	tryRollback()	In a ServerSession failure scenario,\ we may try to rollback, however only if it's not prepared.

Method Detail

getProtocolData

Object getProtocolData()

setProtocolData

void setProtocolData(Object data)

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

isEffective

boolean isEffective()

prepare

void prepare()
      throws Exception

Throws:

Exception

commit

void commit()
     throws Exception

Throws:

Exception

commit

void commit(boolean onePhase)
     throws Exception

Throws:

Exception

rollback

void rollback()
       throws Exception

Throws:

Exception

tryRollback

boolean tryRollback()

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

getID

long getID()

getXid

Xid getXid()

suspend

void suspend()

resume

void resume()

getState

Transaction.State getState()

setState

void setState(Transaction.State state)

markAsRollbackOnly

void markAsRollbackOnly(ActiveMQException exception)

getCreateTime

long getCreateTime()

addOperation

void addOperation(TransactionOperation sync)

afterStore

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

getAllOperations

List<TransactionOperation> getAllOperations()

hasTimedOut

boolean hasTimedOut(long currentTime,
                    int defaultTimeout)

hasTimedOut

boolean hasTimedOut()

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

putProperty

void putProperty(int index,
                 Object property)

getProperty

Object getProperty(int index)

isContainsPersistent

boolean isContainsPersistent()

setContainsPersistent

void setContainsPersistent()

setTimeout

void setTimeout(int timeout)

createRefsOperation

RefsOperation createRefsOperation(Queue queue,
                                  AckReason reason)