Package org.jpos.transaction

Class Context

java.lang.Object

org.jpos.transaction.Context

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Pausable, Loggeable

public class Context
extends java.lang.Object
implements java.io.Externalizable, Loggeable, Pausable, java.lang.Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Context()

Method Summary

Modifier and Type	Method	Description
void	checkPoint(java.lang.String detail)	add a checkpoint to the profiler
Context	clone()
void	dump(java.io.PrintStream p, java.lang.String indent)
protected void	dumpEntry(java.io.PrintStream p, java.lang.String indent, java.util.Map.Entry<java.lang.Object,java.lang.Object> entry)
protected void	dumpMap(java.io.PrintStream p, java.lang.String indent)
boolean	equals(java.lang.Object o)
void	evict(java.lang.Object key)	Evicts a persistent entry
<T> T	get(java.lang.Object key)	Get object instance from transaction context.
<T> T	get(java.lang.Object key, long timeout)	persistent get with timeout
<T> T	get(java.lang.Object key, T defValue)	Get object instance from transaction context.
LogEvent	getLogEvent()	return a LogEvent used to store trace information about this transaction.
java.util.Map<java.lang.Object,java.lang.Object>	getMap()
PausedTransaction	getPausedTransaction()
PausedTransaction	getPausedTransaction(long timeout)
Profiler	getProfiler()	return (or creates) a Profiler object
Result	getResult()	return (or creates) a Resultr object
java.lang.String	getString(java.lang.Object key)
java.lang.String	getString(java.lang.Object key, java.lang.String defValue)
long	getTimeout()
int	hashCode()
boolean	hasKey(java.lang.Object key)	Check if key present
boolean	hasPersistedKey(java.lang.Object key)	Check key exists present persisted map
boolean	isTrace()
void	log(java.lang.Object msg)	adds a trace message
<T> T	move(java.lang.Object from, java.lang.Object to)	Move entry to new key name
void	persist(java.lang.Object key)	Persists a transient entry
void	put(java.lang.Object key, java.lang.Object value)	puts an Object in the transient Map
void	put(java.lang.Object key, java.lang.Object value, boolean persist)	puts an Object in the transient Map
void	readExternal(java.io.ObjectInput in)
<T> T	remove(java.lang.Object key)	Transient remove
void	resume()
void	setPausedTransaction(PausedTransaction p)
void	setTimeout(long timeout)
void	setTrace(boolean trace)
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Context

public Context()

Method Detail

put

public void put(java.lang.Object key,
                java.lang.Object value)

puts an Object in the transient Map

put

public void put(java.lang.Object key,
                java.lang.Object value,
                boolean persist)

puts an Object in the transient Map

persist

public void persist(java.lang.Object key)

Persists a transient entry

Parameters:

key - the key

evict

public void evict(java.lang.Object key)

Evicts a persistent entry

Parameters:

key - the key

get

public <T> T get(java.lang.Object key)

Get object instance from transaction context.

Type Parameters:

T - desired type of object instance

Parameters:

key - the key of object instance

Returns:

object instance if exist in context or null otherwise

hasKey

public boolean hasKey(java.lang.Object key)

Check if key present

Parameters:

key - the key

Returns:

true if present

hasPersistedKey

public boolean hasPersistedKey(java.lang.Object key)

Check key exists present persisted map

Parameters:

key - the key

Returns:

true if present

move

public <T> T move(java.lang.Object from,
                  java.lang.Object to)

Move entry to new key name

Parameters:

from - key

to - key

Returns:

the entry's value (could be null if 'from' key not present)

get

public <T> T get(java.lang.Object key,
                 T defValue)

Get object instance from transaction context.

Type Parameters:

T - desired type of object instance

Parameters:

key - the key of object instance

defValue - default value returned if there is no value in context

Returns:

object instance if exist in context or defValue otherwise

remove

public <T> T remove(java.lang.Object key)

Transient remove

getString

public java.lang.String getString(java.lang.Object key)

getString

public java.lang.String getString(java.lang.Object key,
                                  java.lang.String defValue)

dump

public void dump(java.io.PrintStream p,
                 java.lang.String indent)

Specified by:

dump in interface Loggeable

get

public <T> T get(java.lang.Object key,
                 long timeout)

persistent get with timeout

Parameters:

key - the key

timeout - timeout

Returns:

object (null on timeout)

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

clone

public Context clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getMap

public java.util.Map<java.lang.Object,java.lang.Object> getMap()

Returns:

transient map

dumpMap

protected void dumpMap(java.io.PrintStream p,
                       java.lang.String indent)

dumpEntry

protected void dumpEntry(java.io.PrintStream p,
                         java.lang.String indent,
                         java.util.Map.Entry<java.lang.Object,java.lang.Object> entry)

getLogEvent

public LogEvent getLogEvent()

return a LogEvent used to store trace information about this transaction. If there's no LogEvent there, it creates one.

Returns:

LogEvent

getProfiler

public Profiler getProfiler()

return (or creates) a Profiler object

Returns:

Profiler object

getResult

public Result getResult()

return (or creates) a Resultr object

Returns:

Profiler object

log

public void log(java.lang.Object msg)

adds a trace message

Parameters:

msg - trace information

checkPoint

public void checkPoint(java.lang.String detail)

add a checkpoint to the profiler

setPausedTransaction

public void setPausedTransaction(PausedTransaction p)

Specified by:

setPausedTransaction in interface Pausable

getPausedTransaction

public PausedTransaction getPausedTransaction()

Specified by:

getPausedTransaction in interface Pausable

getPausedTransaction

public PausedTransaction getPausedTransaction(long timeout)

setTimeout

public void setTimeout(long timeout)

Specified by:

setTimeout in interface Pausable

getTimeout

public long getTimeout()

Specified by:

getTimeout in interface Pausable

resume

public void resume()

Specified by:

resume in interface Pausable

isTrace

public boolean isTrace()

setTrace

public void setTrace(boolean trace)