Class Trace

java.lang.Object

org.jpos.transaction.participant.Trace

All Implemented Interfaces:

Configurable, AbortParticipant, TransactionConstants, TransactionParticipant

public class Trace
extends Object
implements AbortParticipant, Configurable

Diagnostic transaction participant that records a configurable trace label at each lifecycle phase via Context.checkPoint(String).

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
Trace()	Creates the participant; configuration is supplied via setConfiguration(Configuration).

Method Summary

Modifier and Type	Method	Description
void	abort(long id, Serializable o)	Called by TransactionManager upon transaction commit.
void	commit(long id, Serializable o)	Called by TransactionManager upon transaction commit.
int	prepare(long id, Serializable o)	Called by TransactionManager in preparation for a transaction
int	prepareForAbort(long id, Serializable o)	Called by TransactionManager in preparation for a transaction that is known to abort.
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.

Methods inherited from class Object

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

Constructor Details

Trace

public Trace()

Creates the participant; configuration is supplied via setConfiguration(Configuration).

Method Details

prepare

public int prepare(long id,
 Serializable o)

Description copied from interface: TransactionParticipant

Called by TransactionManager in preparation for a transaction

Specified by:

prepare in interface TransactionParticipant

Parameters:

id - the Transaction identifier

o - transaction context

Returns:

PREPARED or ABORTED (| NO_JOIN | READONLY)

commit

public void commit(long id,
 Serializable o)

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

o - transaction context

abort

public void abort(long id,
 Serializable o)

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

o - transaction context

prepareForAbort

public int prepareForAbort(long id,
 Serializable o)

Description copied from interface: AbortParticipant

Called by TransactionManager in preparation for a transaction that is known to abort.

Specified by:

prepareForAbort in interface AbortParticipant

Parameters:

id - the Transaction identifier

o - transaction context

Returns:

0 [| NO_JOIN | READONLY)

setConfiguration

public void setConfiguration(Configuration cfg)

Description copied from interface: Configurable

Configures this object with the supplied Configuration.

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - Configuration object