Package org.apache.qpid.protonj2.engine.impl

Class ProtonTransaction<E extends Endpoint<?>>

java.lang.Object

org.apache.qpid.protonj2.engine.impl.ProtonTransaction<E>

Type Parameters:

E - The parent type for this Transaction

All Implemented Interfaces:

Transaction<E>

public abstract class ProtonTransaction<E extends Endpoint<?>>
extends Object
implements Transaction<E>

Base Transaction implementation that provides the basic functionality needed to manage the Transaction that it represents.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.qpid.protonj2.engine.Transaction

Transaction.DischargeState

Constructor Summary

Constructors

Constructor	Description
ProtonTransaction()

Method Summary

Modifier and Type	Method	Description
ProtonAttachments	getAttachments()
ErrorCondition	getCondition()	If the declare or discharge of the transaction caused its state to become TransactionState FAILED this method returns the ErrorCondition that the remote used to describe the reason for the failure.
Transaction.DischargeState	getDischargeState()	For a Transaction that has either been requested to discharge or has successfully discharged the Transaction.DischargeState reflects whether the transaction was to be committed or rolled back.
Object	getLinkedResource()
<T> T	getLinkedResource(Class<T> typeClass)	Gets the linked resource (if set) and returns it using the type information provided to cast the returned value.
TransactionState	getState()
Binary	getTxnId()	Returns the transaction Id that is associated with the declared transaction.
boolean	isDeclared()
boolean	isDischarged()
boolean	isFailed()	The parent resource will mark the Transaction as failed is any of the operations performed on it cannot be successfully completed such as a Declare operation failing to write due to an IO error.
abstract E	parent()	Overridden by the TransactionController or TransactionManager that creates this Transaction instance, this method returns the parent instance that created it.
void	setLinkedResource(Object resource)	Links a given resource to this Transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtonTransaction

public ProtonTransaction()

Method Detail

getState

public TransactionState getState()

Specified by:

getState in interface Transaction<E extends Endpoint<?>>

Returns:

the current Transaction state.

isDeclared

public boolean isDeclared()

Specified by:

isDeclared in interface Transaction<E extends Endpoint<?>>

Returns:

true if the Transaction has been marked declared by the TransactionManager.

isDischarged

public boolean isDischarged()

Specified by:

isDischarged in interface Transaction<E extends Endpoint<?>>

Returns:

true if the Transaction has been marked discharged by the TransactionManager.

isFailed

public boolean isFailed()

Description copied from interface: Transaction

The parent resource will mark the Transaction as failed is any of the operations performed on it cannot be successfully completed such as a Declare operation failing to write due to an IO error.

Specified by:

isFailed in interface Transaction<E extends Endpoint<?>>

Returns:

true if the Transaction has been marked failed by the parent resource.

getCondition

public ErrorCondition getCondition()

Description copied from interface: Transaction

If the declare or discharge of the transaction caused its state to become TransactionState FAILED this method returns the ErrorCondition that the remote used to describe the reason for the failure.

Specified by:

getCondition in interface Transaction<E extends Endpoint<?>>

Returns:

the ErrorCondition that the TransactionManager used to fail the Transaction.

getDischargeState

public Transaction.DischargeState getDischargeState()

Description copied from interface: Transaction

For a Transaction that has either been requested to discharge or has successfully discharged the Transaction.DischargeState reflects whether the transaction was to be committed or rolled back. Prior to a discharge being attempted there is no state value and this method returns a Transaction.DischargeState of none.

Specified by:

getDischargeState in interface Transaction<E extends Endpoint<?>>

Returns:

the current Transaction.DischargeState of the transaction.

getTxnId

public Binary getTxnId()

Description copied from interface: Transaction

Returns the transaction Id that is associated with the declared transaction. Prior to a TransactionManager completing a transaction declaration this method will return null to indicate that the transaction has not been declared yet.

Specified by:

getTxnId in interface Transaction<E extends Endpoint<?>>

Returns:

the transaction Id associated with the transaction once successfully declared.

setLinkedResource

public void setLinkedResource(Object resource)

Description copied from interface: Transaction

Links a given resource to this Transaction.

Specified by:

setLinkedResource in interface Transaction<E extends Endpoint<?>>

Parameters:

resource - The resource to link to this Transaction.

getLinkedResource

public Object getLinkedResource()

Specified by:

getLinkedResource in interface Transaction<E extends Endpoint<?>>

Returns:

the user set linked resource for this Transaction instance.

getLinkedResource

public <T> T getLinkedResource(Class<T> typeClass)

Description copied from interface: Transaction

Gets the linked resource (if set) and returns it using the type information provided to cast the returned value.

Specified by:

getLinkedResource in interface Transaction<E extends Endpoint<?>>

Type Parameters:

T - The type to cast the linked resource to if one is set.

Parameters:

typeClass - the type's Class which is used for casting the returned value.

Returns:

the user set linked resource for this Context instance.

getAttachments

public ProtonAttachments getAttachments()

Specified by:

getAttachments in interface Transaction<E extends Endpoint<?>>

Returns:

the Attachments instance that is associated with this Transaction

parent

public abstract E parent()

Overridden by the TransactionController or TransactionManager that creates this Transaction instance, this method returns the parent instance that created it.

Specified by:

parent in interface Transaction<E extends Endpoint<?>>

Returns:

the resource that created this Transaction.