Class SendResponse

java.lang.Object

org.jpos.transaction.participant.SendResponse

All Implemented Interfaces:

Configurable, AbortParticipant, TransactionConstants, TransactionParticipant

public class SendResponse
extends Object
implements AbortParticipant, Configurable

Transaction participant that sends the response message stored in the Context back over the originating ISOSource, with optional header handling driven by SendResponse.HeaderStrategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SendResponse.HeaderStrategy	Selects how the response message's ISO header is populated before sending.

Field Summary

Fields inherited from interface TransactionConstants

ABORTED, FAIL, NO_JOIN, PAUSE, PREPARED, READONLY, RETRY

Modifier and Type	Field	Description
static final int	ABORTED	Transaction has been aborted.
static final int	FAIL	Shortcut for a read-only, non-joining abort (READONLY | NO_JOIN).
static final int	NO_JOIN	This participant does not join the transaction
static final int	PAUSE	Transaction is paused.
static final int	PREPARED	Transaction has been prepared successfully.
static final int	READONLY	Context has not been modified (no need to persist a snapshot)
static final int	RETRY	Transaction should be retried.

Constructor Summary

Constructors

Constructor	Description
SendResponse()	Default constructor; no instance state to initialise.

Method Summary

Modifier and Type	Method	Description
void	abort(long id, Serializable context)	Called by TransactionManager upon transaction commit.
void	commit(long id, Serializable context)	Called by TransactionManager upon transaction commit.
int	prepare(long id, Serializable context)	Called by TransactionManager in preparation for a transaction
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.
void	setTransactionManager(TransactionManager tm)	Captures the input space from the hosting transaction manager so the participant can re-arm a SpaceSource during commit.

Methods inherited from class Object

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

Methods inherited from interface AbortParticipant

prepareForAbort

Modifier and Type	Method	Description
default int	prepareForAbort(long id, Serializable context)	Called by TransactionManager in preparation for a transaction that is known to abort.

Constructor Details

SendResponse

public SendResponse()

Default constructor; no instance state to initialise.

Method Details

prepare

public int prepare(long id,
 Serializable context)

Description copied from interface: TransactionParticipant

Called by TransactionManager in preparation for a transaction

Specified by:

prepare in interface TransactionParticipant

Parameters:

id - the Transaction identifier

context - transaction context

Returns:

PREPARED or ABORTED (| NO_JOIN | READONLY)

commit

public void commit(long id,
 Serializable context)

Description copied from interface: TransactionParticipant

Called by TransactionManager upon transaction commit. Warning: implementation should be able to handle multiple calls with the same transaction id (rare crash recovery)

Specified by:

commit in interface TransactionParticipant

Parameters:

id - the Transaction identifier

context - transaction context

abort

public void abort(long id,
 Serializable context)

Description copied from interface: TransactionParticipant

Called by TransactionManager upon transaction commit. Warning: implementation should be able to handle multiple calls with the same transaction id (rare crash recovery)

Specified by:

abort in interface TransactionParticipant

Parameters:

id - the Transaction identifier

context - transaction context

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException

Description copied from interface: Configurable

Configures this object with the supplied Configuration.

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - Configuration object

Throws:

ConfigurationException - if the configuration is invalid

setTransactionManager

public void setTransactionManager(TransactionManager tm)

Captures the input space from the hosting transaction manager so the participant can re-arm a SpaceSource during commit.

Parameters:

tm - the hosting transaction manager