Package org.apache.qpid.protonj2.engine

Interface TransactionManager

All Superinterfaces:

Endpoint<TransactionManager>

All Known Implementing Classes:

ProtonTransactionManager

public interface TransactionManager
extends Endpoint<TransactionManager>

Transaction Manager endpoint that implements the mechanics of handling the declaration of and the requested discharge of AMQP transactions. Typically an AMQP server instance will host the transaction management services that are used by client resources to declare and discharge transaction and handle the associated of deliveries that are enlisted in active transactions.

Method Summary

Modifier and Type	Method	Description
TransactionManager	addCredit(int additionalCredit)	Adds the given amount of credit for the TransactionManager which allows the TransactionController to send Declare and Discharge requests to this manager.
default TransactionManager	declared(Transaction<TransactionManager> transaction, byte[] txnId)	Respond to a previous Declare request from the remote TransactionController indicating that the requested transaction has been successfully declared and that deliveries can now be enlisted in that transaction.
TransactionManager	declared(Transaction<TransactionManager> transaction, Binary txnId)	Respond to a previous Declare request from the remote TransactionController indicating that the requested transaction has been successfully declared and that deliveries can now be enlisted in that transaction.
TransactionManager	declareFailed(Transaction<TransactionManager> transaction, ErrorCondition condition)	Respond to a previous Declare request from the remote TransactionController indicating that the requested transaction declaration has failed and is not active.
TransactionManager	declareHandler(EventHandler<Transaction<TransactionManager>> declaredEventHandler)	Called when the TransactionController end of the link has requested a new transaction be declared using the information provided in the given Declare instance.
TransactionManager	discharged(Transaction<TransactionManager> transaction)	Respond to a previous Discharge request from the remote TransactionController indicating that the discharge completed on the transaction identified by given transaction Id has now been retired.
TransactionManager	dischargeFailed(Transaction<TransactionManager> transaction, ErrorCondition condition)	Respond to a previous Discharge request from the remote TransactionController indicating that the discharge resulted in an error and the transaction must be considered rolled back.
TransactionManager	dischargeHandler(EventHandler<Transaction<TransactionManager>> dischargeEventHandler)	Called when the TransactionController end of the link has requested a current transaction be discharged using the information provided in the given Discharge instance.
Coordinator	getCoordinator()	Returns the currently set Coordinator target for this Link.
int	getCredit()	Get the credit that is currently available or assigned to this TransactionManager.
Coordinator	getRemoteCoordinator()	Returns the remote target Terminus for this transaction manager which must be of type Coordinator or null if remote did not set a terminus.
Source	getRemoteSource()
Source	getSource()
TransactionManager	parentEndpointClosedHandler(EventHandler<TransactionManager> handler)	Sets a EventHandler for when the parent Session or Connection of this TransactionManager is locally closed.
TransactionManager	setCoordinator(Coordinator coordinator)	Sets the Coordinator target to assign to the local end of this TransactionManager.
TransactionManager	setSource(Source source)	Sets the Source to assign to the local end of this TransactionManager.

Methods inherited from interface org.apache.qpid.protonj2.engine.Endpoint

close, closeHandler, engineShutdownHandler, getAttachments, getCondition, getDesiredCapabilities, getEngine, getLinkedResource, getLinkedResource, getOfferedCapabilities, getParent, getProperties, getRemoteCondition, getRemoteDesiredCapabilities, getRemoteOfferedCapabilities, getRemoteProperties, isLocallyClosed, isLocallyOpen, isRemotelyClosed, isRemotelyOpen, localCloseHandler, localOpenHandler, open, openHandler, setCondition, setDesiredCapabilities, setLinkedResource, setOfferedCapabilities, setProperties

Method Detail

addCredit

TransactionManager addCredit(int additionalCredit)

Adds the given amount of credit for the TransactionManager which allows the TransactionController to send Declare and Discharge requests to this manager. The TransactionController cannot send any requests to start or complete a transaction without having credit to do so which implies that the TransactionManager owner must grant credit as part of its normal processing.

Parameters:

additionalCredit - the new amount of credits to add.

Returns:

this TransactionManager

Throws:

java.lang.IllegalArgumentException - if the credit amount is negative.

getCredit

int getCredit()

Get the credit that is currently available or assigned to this TransactionManager.

Returns:

the current unused credit.

setSource

TransactionManager setSource(Source source)
                      throws java.lang.IllegalStateException

Sets the Source to assign to the local end of this TransactionManager. Must be called during setup, i.e. before calling the Endpoint.open() method.

Parameters:

source - The Source that will be set on the local end of this transaction controller.

Returns:

this transaction controller instance.

Throws:

java.lang.IllegalStateException - if the TransactionManager has already been opened.

getSource

Source getSource()

Returns:

the Source for the local end of this TransactionController.

setCoordinator

TransactionManager setCoordinator(Coordinator coordinator)
                           throws java.lang.IllegalStateException

Sets the Coordinator target to assign to the local end of this TransactionManager. Must be called during setup, i.e. before calling the Endpoint.open() method.

Parameters:

coordinator - The Coordinator target that will be set on the local end of this transaction controller.

Returns:

this transaction controller instance.

Throws:

java.lang.IllegalStateException - if the TransactionManager has already been opened.

getCoordinator

Coordinator getCoordinator()

Returns the currently set Coordinator target for this Link.

Returns:

the link target Coordinator for the local end of this link.

getRemoteSource

Source getRemoteSource()

Returns:

the source Source for the remote end of this TransactionManager.

getRemoteCoordinator

Coordinator getRemoteCoordinator()

Returns the remote target Terminus for this transaction manager which must be of type Coordinator or null if remote did not set a terminus.

Returns:

the remote coordinator Terminus for the remote end of this link.

declared

default TransactionManager declared(Transaction<TransactionManager> transaction,
                                    byte[] txnId)

Respond to a previous Declare request from the remote TransactionController indicating that the requested transaction has been successfully declared and that deliveries can now be enlisted in that transaction.

Parameters:

transaction - The transaction instance that is associated with the declared transaction.

txnId - The binary transaction Id to assign the now declared transaction instance.

Returns:

this TransactionManager.

declared

TransactionManager declared(Transaction<TransactionManager> transaction,
                            Binary txnId)

Respond to a previous Declare request from the remote TransactionController indicating that the requested transaction has been successfully declared and that deliveries can now be enlisted in that transaction.

Parameters:

transaction - The transaction instance that is associated with the declared transaction.

txnId - The binary transaction Id to assign the now declared transaction instance.

Returns:

this TransactionManager.

declareFailed

TransactionManager declareFailed(Transaction<TransactionManager> transaction,
                                 ErrorCondition condition)

Respond to a previous Declare request from the remote TransactionController indicating that the requested transaction declaration has failed and is not active.

Parameters:

transaction - The transaction instance that is associated with the declared transaction.

condition - The ErrorCondition that described the reason for the transaction failure.

Returns:

this TransactionManager.

discharged

TransactionManager discharged(Transaction<TransactionManager> transaction)

Respond to a previous Discharge request from the remote TransactionController indicating that the discharge completed on the transaction identified by given transaction Id has now been retired.

Parameters:

transaction - The Transaction instance that has been discharged and is now retired.

Returns:

this TransactionManager.

dischargeFailed

TransactionManager dischargeFailed(Transaction<TransactionManager> transaction,
                                   ErrorCondition condition)

Respond to a previous Discharge request from the remote TransactionController indicating that the discharge resulted in an error and the transaction must be considered rolled back.

Parameters:

transaction - The Transaction instance that has been discharged and is now retired.

condition - The ErrorCondition that described the reason for the transaction failure.

Returns:

this TransactionManager.

declareHandler

TransactionManager declareHandler(EventHandler<Transaction<TransactionManager>> declaredEventHandler)

Called when the TransactionController end of the link has requested a new transaction be declared using the information provided in the given Declare instance.

Parameters:

declaredEventHandler - handler that will act on the transaction declaration request.

Returns:

this TransactionManager.

dischargeHandler

TransactionManager dischargeHandler(EventHandler<Transaction<TransactionManager>> dischargeEventHandler)

Called when the TransactionController end of the link has requested a current transaction be discharged using the information provided in the given Discharge instance.

Parameters:

dischargeEventHandler - handler that will act on the transaction declaration request.

Returns:

this TransactionManager.

parentEndpointClosedHandler

TransactionManager parentEndpointClosedHandler(EventHandler<TransactionManager> handler)

Sets a EventHandler for when the parent Session or Connection of this TransactionManager is locally closed. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined.

Parameters:

handler - The EventHandler to notify when this transaction manger's parent endpoint is locally closed.

Returns:

the link for chaining.