Class Debug

java.lang.Object

org.jpos.util.Log

org.jpos.transaction.participant.Debug

All Implemented Interfaces:

AbortParticipant, TransactionConstants, TransactionParticipant, LogSource

public class Debug
extends Log
implements AbortParticipant

Diagnostic transaction participant that logs the Context at every lifecycle phase, useful for tracing TM behaviour during development.

Field Summary

Fields inherited from class Log

DEBUG, defaultTags, ERROR, FATAL, INFO, logger, realm, TRACE, WARN

Modifier and Type	Field	Description
static final String	DEBUG	Level constant for debug events.
protected final Map<String,String>	defaultTags	Default tags applied to every LogEvent created by this Log.
static final String	ERROR	Level constant for error events.
static final String	FATAL	Level constant for fatal events.
static final String	INFO	Level constant for informational events.
protected Logger	logger	Logger receiving the events produced by this Log.
protected String	realm	Realm associated with events emitted through this Log.
static final String	TRACE	Level constant for trace events.
static final String	WARN	Level constant for warning events.

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
Debug()	Default constructor; no instance state to initialise.

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.

Methods inherited from class Log

applyDefaultTags, createDebug, createDebug, createError, createError, createFatal, createFatal, createInfo, createInfo, createLogEvent, createLogEvent, createTrace, createTrace, createWarn, createWarn, debug, debug, error, error, fatal, fatal, getDefaultTags, getLog, getLogger, getRealm, info, info, removeDefaultTag, setDefaultTag, setDefaultTags, setLogger, setLogger, setRealm, trace, trace, warn, warn

Modifier and Type	Method	Description
protected LogEvent	applyDefaultTags(LogEvent evt)	Decorates evt with this Log's default tags, if any.
LogEvent	createDebug()	Creates an empty debug-level event.
LogEvent	createDebug(Object detail)	Creates a debug-level event with the given payload.
LogEvent	createError()	Creates an empty error-level event.
LogEvent	createError(Object detail)	Creates an error-level event with the given payload.
LogEvent	createFatal()	Creates an empty fatal-level event.
LogEvent	createFatal(Object detail)	Creates a fatal-level event with the given payload.
LogEvent	createInfo()	Creates an empty info-level event.
LogEvent	createInfo(Object detail)	Creates an info-level event with the given payload.
LogEvent	createLogEvent(String level)	Creates a new LogEvent at the given level decorated with this Log's default tags.
LogEvent	createLogEvent(String level, Object detail)	Creates a new LogEvent at the given level with an initial payload.
LogEvent	createTrace()	Creates an empty trace-level event.
LogEvent	createTrace(Object detail)	Creates a trace-level event with the given payload.
LogEvent	createWarn()	Creates an empty warning-level event.
LogEvent	createWarn(Object detail)	Creates a warning-level event with the given payload.
void	debug(Object detail)	Logs a debug event with the given detail.
void	debug(Object detail, Object obj)	Logs a debug event with the given detail and an additional payload.
void	error(Object detail)	Logs an error event with the given detail.
void	error(Object detail, Object obj)	Logs an error event with the given detail and an additional payload.
void	fatal(Object detail)	Logs a fatal event with the given detail.
void	fatal(Object detail, Object obj)	Logs a fatal event with the given detail and an additional payload.
Map<String,String>	getDefaultTags()	Returns an unmodifiable snapshot of the current default tags.
static Log	getLog(String logName, String realm)	Convenience factory returning a Log bound to the given logger name and realm.
Logger	getLogger()	Returns the underlying logger.
String	getRealm()	Returns the realm associated with events emitted through this Log.
void	info(Object detail)	Logs an info event with the given detail.
void	info(Object detail, Object obj)	Logs an info event with the given detail and an additional payload.
void	removeDefaultTag(String key)	Removes a previously-registered default tag.
void	setDefaultTag(String key, String value)	Sets a default tag on every event produced by this Log; a null value removes the entry.
void	setDefaultTags(Map<String,String> tags)	Replaces the entire set of default tags.
void	setLogger(Logger logger)	Replaces the underlying logger, leaving the realm unchanged.
void	setLogger(Logger logger, String realm)	Replaces the underlying logger and realm.
void	setRealm(String realm)	Replaces the realm associated with emitted events.
void	trace(Object detail)	Logs a trace event with the given detail.
void	trace(Object detail, Object obj)	Logs a trace event with the given detail and an additional payload.
void	warn(Object detail)	Logs a warning event with the given detail.
void	warn(Object detail, Object obj)	Logs a warning event with the given detail and an additional payload.

Methods inherited from class Object

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

Constructor Details

Debug

public Debug()

Default constructor; no instance state to initialise.

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)