Class ProtonTransactionController
- java.lang.Object
-
- org.apache.qpid.protonj2.engine.impl.ProtonEndpoint<TransactionController>
-
- org.apache.qpid.protonj2.engine.impl.ProtonTransactionController
-
- All Implemented Interfaces:
Endpoint<TransactionController>
,TransactionController
public class ProtonTransactionController extends ProtonEndpoint<TransactionController> implements TransactionController
TransactionController
implementation that implements the abstraction around a sender link that initiates requests toDeclare
and toDischarge
AMQPTransaction
instance.
-
-
Field Summary
-
Fields inherited from class org.apache.qpid.protonj2.engine.impl.ProtonEndpoint
engine
-
-
Constructor Summary
Constructors Constructor Description ProtonTransactionController(ProtonSender senderLink)
Creates a newTransactionController
instance that wraps the givenSender
link.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProtonTransactionController
addCapacityAvailableHandler(EventHandler<TransactionController> handler)
Allows the caller to add anEventHandler
that will be signaled when the underlying link for thisTransactionController
has been granted credit which would then allow for transactionDeclared
andDischarge
commands to be sent to the remote Transactional Resource.TransactionController
close()
Close the end point locally and send the closing performative immediately if possible or holds it until the Connection / Engine state allows it.Transaction<TransactionController>
declare()
Request that the remoteTransactionManager
declare a new transaction and respond with a new transaction Id for that transaction.TransactionController
declare(Transaction<TransactionController> transaction)
Request that the remoteTransactionManager
declare a new transaction and respond with a new transaction Id for that transaction.TransactionController
declaredHandler(EventHandler<Transaction<TransactionController>> declaredEventHandler)
Called when theTransactionManager
end of the link has responded to a previousDeclare
request and the transaction can now be used to enroll deliveries into the active transaction.TransactionController
declareFailureHandler(EventHandler<Transaction<TransactionController>> declareFailureEventHandler)
Called when theTransactionManager
end of the link responds to aTransaction
declaration with anRejected
outcome indicating that the transaction could not be successfully declared.TransactionController
discharge(Transaction<TransactionController> transaction, boolean failed)
Request that the remoteTransactionManager
discharge the given transaction and with the specified failure state (true for failed).TransactionController
dischargedHandler(EventHandler<Transaction<TransactionController>> dischargedEventHandler)
Called when theTransactionManager
end of the link has responded to a previousTransactionController.discharge(Transaction, boolean)
request and the transaction has been retired.TransactionController
dischargeFailureHandler(EventHandler<Transaction<TransactionController>> dischargeFailureEventHandler)
Called when theTransactionManager
end of the link has responded to a previousTransactionController.discharge(Transaction, boolean)
request and the transaction discharge failed for some reason.ErrorCondition
getCondition()
Coordinator
getCoordinator()
Returns the currently set Coordinator target for thisLink
.Symbol[]
getDesiredCapabilities()
Symbol[]
getOfferedCapabilities()
ProtonSession
getParent()
Gets the parent of thisEndpoint
which can be itself forConnection
instance.Map<Symbol,Object>
getProperties()
ErrorCondition
getRemoteCondition()
If the remote has closed thisEndpoint
and provided anErrorCondition
as part of the closing AMQP performative then this method will return it.Coordinator
getRemoteCoordinator()
Returns the remote targetTerminus
for this transaction controller which must be of typeCoordinator
or null if remote did not set a terminus.Symbol[]
getRemoteDesiredCapabilities()
Symbol[]
getRemoteOfferedCapabilities()
Map<Symbol,Object>
getRemoteProperties()
Source
getRemoteSource()
Source
getSource()
boolean
hasCapacity()
Returnstrue
if theTransactionController
has capacity to send or buffer andTransaction
command toDeclare
orDischarge
.boolean
isLocallyClosed()
Returns true if thisEndpoint
is currently locally closed meaning that a call to theEndpoint.close()
method has occurred.boolean
isLocallyOpen()
Returns true if thisEndpoint
is currently locally open meaning that theEndpoint.open()
has been called but theEndpoint.close()
has not.boolean
isRemotelyClosed()
boolean
isRemotelyOpen()
org.apache.qpid.protonj2.engine.impl.ProtonTransactionController.ProtonControllerTransaction
newTransaction()
Creates a newTransaction
instances that is returned in theTransactionState.IDLE
state which can be populated with application specific attachments or assigned a linked resource prior to calling theTransactionController
open()
Open the end point locally, sending the Open performative immediately if possible or holding it until SASL negotiations or the AMQP header exchange and other required performative exchanges has completed.TransactionController
parentEndpointClosedHandler(EventHandler<TransactionController> handler)
Sets aEventHandler
for when the parentSession
orConnection
of thisTransactionController
is locally closed.TransactionController
setCondition(ErrorCondition condition)
Sets the localErrorCondition
to be applied to aEndpoint
close.TransactionController
setCoordinator(Coordinator coordinator)
Sets theCoordinator
target to assign to the local end of thisTransactionController
.TransactionController
setDesiredCapabilities(Symbol... desiredCapabilities)
Sets the capabilities that are desired from the remote when thisEndpoint
is opened.TransactionController
setOfferedCapabilities(Symbol... offeredCapabilities)
Sets the capabilities to be offered on to the remote when thisEndpoint
is opened.TransactionController
setProperties(Map<Symbol,Object> properties)
Sets the properties to be sent to the remote when thisEndpoint
is Opened.TransactionController
setSource(Source source)
Sets theSource
to assign to the local end of thisTransactionController
.Collection<Transaction<TransactionController>>
transactions()
Returns a list ofTransaction
objects that are active within thisTransactionController
which have not reached a terminal state meaning they have not been successfully discharged and have not failed in either theDeclare
phase or theDischarge
phase.-
Methods inherited from class org.apache.qpid.protonj2.engine.impl.ProtonEndpoint
closeHandler, engineShutdownHandler, getAttachments, getEngine, getLinkedResource, getLinkedResource, localCloseHandler, localOpenHandler, openHandler, setLinkedResource
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.qpid.protonj2.engine.Endpoint
closeHandler, engineShutdownHandler, getAttachments, getEngine, getLinkedResource, getLinkedResource, localCloseHandler, localOpenHandler, openHandler, setLinkedResource
-
-
-
-
Constructor Detail
-
ProtonTransactionController
public ProtonTransactionController(ProtonSender senderLink)
Creates a newTransactionController
instance that wraps the givenSender
link.- Parameters:
senderLink
- TheSender
that thisTransactionController
wraps.
-
-
Method Detail
-
getParent
public ProtonSession getParent()
Description copied from interface:Endpoint
Gets the parent of thisEndpoint
which can be itself forConnection
instance.- Specified by:
getParent
in interfaceEndpoint<TransactionController>
- Returns:
- the parent of this
Endpoint
or itself if this is aConnection
;
-
hasCapacity
public boolean hasCapacity()
Description copied from interface:TransactionController
Returnstrue
if theTransactionController
has capacity to send or buffer andTransaction
command toDeclare
orDischarge
. If no capacity then a call toTransactionController.declare()
or toTransactionController.discharge(Transaction, boolean)
would throw an exception.- Specified by:
hasCapacity
in interfaceTransactionController
- Returns:
- true if the controller will allow declaring or discharging a transaction at this time.
-
addCapacityAvailableHandler
public ProtonTransactionController addCapacityAvailableHandler(EventHandler<TransactionController> handler)
Description copied from interface:TransactionController
Allows the caller to add anEventHandler
that will be signaled when the underlying link for thisTransactionController
has been granted credit which would then allow for transactionDeclared
andDischarge
commands to be sent to the remote Transactional Resource. If the controller already has credit to send then the handler will be invoked immediately otherwise it will be stored until credit becomes available. Once a handler is signaled it is no longer retained for future updates and the caller will need to register it again once more transactional work is to be completed. Because more than one handler can be added at a time the caller should check again before attempting to perform a transactionDeclared
orDischarge
is performed as other tasks might have already consumed credit if work is done via some asynchronous mechanism.- Specified by:
addCapacityAvailableHandler
in interfaceTransactionController
- Parameters:
handler
- TheEventHandler
that will be signaled once credit is available for transaction work.- Returns:
- this
TransactionController
instance.
-
transactions
public Collection<Transaction<TransactionController>> transactions()
Description copied from interface:TransactionController
Returns a list ofTransaction
objects that are active within thisTransactionController
which have not reached a terminal state meaning they have not been successfully discharged and have not failed in either theDeclare
phase or theDischarge
phase. If there are no transactions active within thisTransactionController
this method returns an emptyCollection
.- Specified by:
transactions
in interfaceTransactionController
- Returns:
- a list of Transactions that are allocated to this controller that have not reached a terminal state.
-
newTransaction
public org.apache.qpid.protonj2.engine.impl.ProtonTransactionController.ProtonControllerTransaction newTransaction()
Description copied from interface:TransactionController
Creates a newTransaction
instances that is returned in theTransactionState.IDLE
state which can be populated with application specific attachments or assigned a linked resource prior to calling the- Specified by:
newTransaction
in interfaceTransactionController
- Returns:
- a new
Transaction
instance that can be correlated with later declared events.
-
declare
public Transaction<TransactionController> declare()
Description copied from interface:TransactionController
Request that the remoteTransactionManager
declare a new transaction and respond with a new transaction Id for that transaction. Upon successful declaration of a new transaction the remote will respond and theTransactionController.declaredHandler(EventHandler)
event handler will be signaled. This is a convenience method that is the same as first callingTransactionController.newTransaction()
and then passing the result of that to theTransactionController.declare(Transaction)
method.- Specified by:
declare
in interfaceTransactionController
- Returns:
- a new
Transaction
instance that can be correlated with later declared events.
-
declare
public TransactionController declare(Transaction<TransactionController> transaction)
Description copied from interface:TransactionController
Request that the remoteTransactionManager
declare a new transaction and respond with a new transaction Id for that transaction. Upon successful declaration of a new transaction the remote will respond and theTransactionController.declaredHandler(EventHandler)
event handler will be signaled.- Specified by:
declare
in interfaceTransactionController
- Parameters:
transaction
- TheTransaction
that is will be associated with the eventual declared transaction.- Returns:
- this
TransactionController
-
discharge
public TransactionController discharge(Transaction<TransactionController> transaction, boolean failed)
Description copied from interface:TransactionController
Request that the remoteTransactionManager
discharge the given transaction and with the specified failure state (true for failed). Upon successful declaration of a new transaction the remote will respond and theTransactionController.declaredHandler(EventHandler)
event handler will be signaled.- Specified by:
discharge
in interfaceTransactionController
- Parameters:
transaction
- TheTransaction
that is being discharged.failed
- boolean value indicating the the discharge indicates the transaction failed (rolled back).- Returns:
- this
TransactionController
-
declaredHandler
public TransactionController declaredHandler(EventHandler<Transaction<TransactionController>> declaredEventHandler)
Description copied from interface:TransactionController
Called when theTransactionManager
end of the link has responded to a previousDeclare
request and the transaction can now be used to enroll deliveries into the active transaction.- Specified by:
declaredHandler
in interfaceTransactionController
- Parameters:
declaredEventHandler
- AnEventHandler
that will act on the transaction declaration request.- Returns:
- this
TransactionController
.
-
declareFailureHandler
public TransactionController declareFailureHandler(EventHandler<Transaction<TransactionController>> declareFailureEventHandler)
Description copied from interface:TransactionController
Called when theTransactionManager
end of the link responds to aTransaction
declaration with anRejected
outcome indicating that the transaction could not be successfully declared.- Specified by:
declareFailureHandler
in interfaceTransactionController
- Parameters:
declareFailureEventHandler
- AnEventHandler
that will be called when a previous transaction declaration fails.- Returns:
- this
TransactionController
.
-
dischargedHandler
public TransactionController dischargedHandler(EventHandler<Transaction<TransactionController>> dischargedEventHandler)
Description copied from interface:TransactionController
Called when theTransactionManager
end of the link has responded to a previousTransactionController.discharge(Transaction, boolean)
request and the transaction has been retired.- Specified by:
dischargedHandler
in interfaceTransactionController
- Parameters:
dischargedEventHandler
- AnEventHandler
that will act on the transaction discharge request.- Returns:
- this
TransactionController
.
-
dischargeFailureHandler
public TransactionController dischargeFailureHandler(EventHandler<Transaction<TransactionController>> dischargeFailureEventHandler)
Description copied from interface:TransactionController
Called when theTransactionManager
end of the link has responded to a previousTransactionController.discharge(Transaction, boolean)
request and the transaction discharge failed for some reason.- Specified by:
dischargeFailureHandler
in interfaceTransactionController
- Parameters:
dischargeFailureEventHandler
- AnEventHandler
that will act on the transaction discharge failed event.- Returns:
- this
TransactionController
.
-
parentEndpointClosedHandler
public TransactionController parentEndpointClosedHandler(EventHandler<TransactionController> handler)
Description copied from interface:TransactionController
Sets aEventHandler
for when the parentSession
orConnection
of thisTransactionController
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.- Specified by:
parentEndpointClosedHandler
in interfaceTransactionController
- Parameters:
handler
- TheEventHandler
to notify when this transaction controller's parent endpoint is locally closed.- Returns:
- the link for chaining.
-
open
public TransactionController open() throws IllegalStateException, EngineStateException
Description copied from interface:Endpoint
Open the end point locally, sending the Open performative immediately if possible or holding it until SASL negotiations or the AMQP header exchange and other required performative exchanges has completed. The end point will signal any registered handler of the remote opening the Connection once the remote performative that signals open completion arrives.- Specified by:
open
in interfaceEndpoint<TransactionController>
- Returns:
- this
Endpoint
instance. - Throws:
EngineStateException
- if an error occurs opening the Connection or the Engine is shutdown.IllegalStateException
-
close
public TransactionController close() throws EngineFailedException
Description copied from interface:Endpoint
Close the end point locally and send the closing performative immediately if possible or holds it until the Connection / Engine state allows it. If the engine encounters an error writing the performative or the engine is in a failed state from a previous error then this method will throw an exception. If the engine has been shutdown then this method will close out the local end of theEndpoint
and clean up any local resources before returning normally.- Specified by:
close
in interfaceEndpoint<TransactionController>
- Returns:
- this
Endpoint
instance. - Throws:
EngineFailedException
- if an error occurs closing the end point or the Engine is in a failed state.
-
isLocallyOpen
public boolean isLocallyOpen()
Description copied from interface:Endpoint
Returns true if thisEndpoint
is currently locally open meaning that theEndpoint.open()
has been called but theEndpoint.close()
has not.- Specified by:
isLocallyOpen
in interfaceEndpoint<TransactionController>
- Returns:
true
if theEndpoint
is locally open.- See Also:
Endpoint.isLocallyClosed()
-
isLocallyClosed
public boolean isLocallyClosed()
Description copied from interface:Endpoint
Returns true if thisEndpoint
is currently locally closed meaning that a call to theEndpoint.close()
method has occurred.- Specified by:
isLocallyClosed
in interfaceEndpoint<TransactionController>
- Returns:
true
if theEndpoint
is locally closed.- See Also:
Endpoint.isLocallyOpen()
-
setSource
public TransactionController setSource(Source source) throws IllegalStateException
Description copied from interface:TransactionController
Sets theSource
to assign to the local end of thisTransactionController
. Must be called during setup, i.e. before calling theEndpoint.open()
method.- Specified by:
setSource
in interfaceTransactionController
- Parameters:
source
- TheSource
that will be set on the local end of this transaction controller.- Returns:
- this transaction controller instance.
- Throws:
IllegalStateException
- if theTransactionController
has already been opened.
-
getSource
public Source getSource()
- Specified by:
getSource
in interfaceTransactionController
- Returns:
- the
Source
for the local end of thisTransactionController
.
-
setCoordinator
public TransactionController setCoordinator(Coordinator coordinator) throws IllegalStateException
Description copied from interface:TransactionController
Sets theCoordinator
target to assign to the local end of thisTransactionController
. Must be called during setup, i.e. before calling theEndpoint.open()
method.- Specified by:
setCoordinator
in interfaceTransactionController
- Parameters:
coordinator
- TheCoordinator
target that will be set on the local end of this transaction controller.- Returns:
- this transaction controller instance.
- Throws:
IllegalStateException
- if theTransactionController
has already been opened.
-
getCoordinator
public Coordinator getCoordinator()
Description copied from interface:TransactionController
Returns the currently set Coordinator target for thisLink
.- Specified by:
getCoordinator
in interfaceTransactionController
- Returns:
- the link target
Coordinator
for the local end of this link.
-
getCondition
public ErrorCondition getCondition()
- Specified by:
getCondition
in interfaceEndpoint<TransactionController>
- Overrides:
getCondition
in classProtonEndpoint<TransactionController>
- Returns:
- the local
Endpoint
error, or null if there is none
-
setCondition
public TransactionController setCondition(ErrorCondition condition)
Description copied from interface:Endpoint
Sets the localErrorCondition
to be applied to aEndpoint
close.- Specified by:
setCondition
in interfaceEndpoint<TransactionController>
- Overrides:
setCondition
in classProtonEndpoint<TransactionController>
- Parameters:
condition
- The error condition to convey to the remote peer on close of this end point.- Returns:
- this
Endpoint
instance.
-
getProperties
public Map<Symbol,Object> getProperties()
- Specified by:
getProperties
in interfaceEndpoint<TransactionController>
- Returns:
- the configured properties sent to the remote when this Connection is opened.
-
setProperties
public TransactionController setProperties(Map<Symbol,Object> properties) throws IllegalStateException
Description copied from interface:Endpoint
Sets the properties to be sent to the remote when thisEndpoint
is Opened. TheEndpoint
properties value can only be modified prior to a call toEndpoint.open()
, once theEndpoint
has been opened locally an error will be thrown if this method is called.- Specified by:
setProperties
in interfaceEndpoint<TransactionController>
- Parameters:
properties
- The properties that will be sent to the remote when this Connection is opened.- Returns:
- this
Endpoint
instance. - Throws:
IllegalStateException
- if theEndpoint
has already been opened.
-
setOfferedCapabilities
public TransactionController setOfferedCapabilities(Symbol... offeredCapabilities) throws IllegalStateException
Description copied from interface:Endpoint
Sets the capabilities to be offered on to the remote when thisEndpoint
is opened. The offered capabilities value can only be modified prior to a call toEndpoint.open()
, once theEndpoint
has been opened locally an error will be thrown if this method is called.- Specified by:
setOfferedCapabilities
in interfaceEndpoint<TransactionController>
- Parameters:
offeredCapabilities
- The capabilities to be offered to the remote when theEndpoint
is opened.- Returns:
- this
Endpoint
instance. - Throws:
IllegalStateException
- if theEndpoint
has already been opened.
-
getOfferedCapabilities
public Symbol[] getOfferedCapabilities()
- Specified by:
getOfferedCapabilities
in interfaceEndpoint<TransactionController>
- Returns:
- the configured capabilities that are offered to the remote when the
Endpoint
is opened.
-
setDesiredCapabilities
public TransactionController setDesiredCapabilities(Symbol... desiredCapabilities) throws IllegalStateException
Description copied from interface:Endpoint
Sets the capabilities that are desired from the remote when thisEndpoint
is opened. The desired capabilities value can only be modified prior to a call toEndpoint.open()
, once theEndpoint
has been opened locally an error will be thrown if this method is called.- Specified by:
setDesiredCapabilities
in interfaceEndpoint<TransactionController>
- Parameters:
desiredCapabilities
- The capabilities desired from the remote when theEndpoint
is opened.- Returns:
- this
Endpoint
instance. - Throws:
IllegalStateException
- if theEndpoint
has already been opened.
-
getDesiredCapabilities
public Symbol[] getDesiredCapabilities()
- Specified by:
getDesiredCapabilities
in interfaceEndpoint<TransactionController>
- Returns:
- the configured desired capabilities that are sent to the remote when the Connection is opened.
-
isRemotelyOpen
public boolean isRemotelyOpen()
Description copied from interface:Endpoint
Returns true if thisEndpoint
is currently remotely open meaning that the AMQP performative that completes the open phase of thisEndpoint
's lifetime has arrived but the performative that closes it has not.- Specified by:
isRemotelyOpen
in interfaceEndpoint<TransactionController>
- Returns:
true
if theEndpoint
is remotely open.- See Also:
Endpoint.isRemotelyClosed()
-
isRemotelyClosed
public boolean isRemotelyClosed()
Description copied from interface:Endpoint
Returns true if thisEndpoint
is currently remotely closed meaning that the AMQP performative that completes the close phase of thisEndpoint
's lifetime has arrived.- Specified by:
isRemotelyClosed
in interfaceEndpoint<TransactionController>
- Returns:
true
if theEndpoint
is remotely closed.- See Also:
Endpoint.isRemotelyOpen()
-
getRemoteOfferedCapabilities
public Symbol[] getRemoteOfferedCapabilities()
- Specified by:
getRemoteOfferedCapabilities
in interfaceEndpoint<TransactionController>
- Returns:
- the capabilities offered by the remote when it opened its end of the
Endpoint
.
-
getRemoteDesiredCapabilities
public Symbol[] getRemoteDesiredCapabilities()
- Specified by:
getRemoteDesiredCapabilities
in interfaceEndpoint<TransactionController>
- Returns:
- the capabilities desired by the remote when it opened its end of the
Endpoint
.
-
getRemoteProperties
public Map<Symbol,Object> getRemoteProperties()
- Specified by:
getRemoteProperties
in interfaceEndpoint<TransactionController>
- Returns:
- the properties sent by the remote when it opened its end of the
Endpoint
.
-
getRemoteCondition
public ErrorCondition getRemoteCondition()
Description copied from interface:Endpoint
If the remote has closed thisEndpoint
and provided anErrorCondition
as part of the closing AMQP performative then this method will return it.- Specified by:
getRemoteCondition
in interfaceEndpoint<TransactionController>
- Overrides:
getRemoteCondition
in classProtonEndpoint<TransactionController>
- Returns:
- the remote supplied
ErrorCondition
, or null if there is none.
-
getRemoteSource
public Source getRemoteSource()
- Specified by:
getRemoteSource
in interfaceTransactionController
- Returns:
- the source
Source
for the remote end of thisTransactionController
.
-
getRemoteCoordinator
public Coordinator getRemoteCoordinator()
Description copied from interface:TransactionController
Returns the remote targetTerminus
for this transaction controller which must be of typeCoordinator
or null if remote did not set a terminus.- Specified by:
getRemoteCoordinator
in interfaceTransactionController
- Returns:
- the remote coordinator
Terminus
for the remote end of this link.
-
-