Enum Class ContextConstants

java.lang.Object

java.lang.Enum<ContextConstants>

org.jpos.transaction.ContextConstants

All Implemented Interfaces:

Serializable, Comparable<ContextConstants>, Constable

public enum ContextConstants
extends Enum<ContextConstants>

Well-known keys for entries placed into a transaction Context.

Each constant's toString() is the canonical context key used across jPOS participants and adaptors. Refer to the source for a concise description of each individual constant.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMOUNT	Settlement/transaction amount.
CAPTURE_DATE	Capture date for clearing/settlement.
CARD	Cardholder/card data captured by the transaction.
DB	Database connection or session reserved for this transaction.
DESTINATION	Routing destination chosen for the transaction.
IRC	International response code resolved during processing.
LOCAL_AMOUNT	Cardholder-billing amount in the cardholder's local currency.
LOGEVT	Aggregated log event for the transaction.
MID	Merchant identifier.
ORIGINAL_DATA_ELEMENTS	Data elements echoed from the original message.
ORIGINAL_MTI	MTI of the original message, when echoing or reversing.
ORIGINAL_STAN	STAN of the original message, when echoing or reversing.
ORIGINAL_TIMESTAMP	Transmission timestamp of the original message.
PANIC	Panic flag indicating the transaction must abort immediately.
PCODE	Processing code.
POS_DATA_CODE	POS data code describing the entry environment.
PROFILER	Per-transaction profiler instance.
REQUEST	Inbound request message.
RESPONSE	Outbound response message.
RESULT	Final Result of the transaction.
SOURCE	Source channel/peer from which the request originated.
TID	Terminal identifier.
TIMESTAMP	Wall-clock timestamp captured when the transaction started.
TRANSACTION_TIMESTAMP	Transaction timestamp from the inbound message.
TRANSMISSION_TIMESTAMP	Transmission timestamp from the inbound message.
TX	Database transaction handle, when applicable.
TXNNAME	Logical transaction name.

Method Summary

Modifier and Type	Method	Description
String	toString()
static ContextConstants	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ContextConstants[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PROFILER

public static final ContextConstants PROFILER

Per-transaction profiler instance.

TIMESTAMP

public static final ContextConstants TIMESTAMP

Wall-clock timestamp captured when the transaction started.

SOURCE

public static final ContextConstants SOURCE

Source channel/peer from which the request originated.

REQUEST

public static final ContextConstants REQUEST

Inbound request message.

RESPONSE

public static final ContextConstants RESPONSE

Outbound response message.

LOGEVT

public static final ContextConstants LOGEVT

Aggregated log event for the transaction.

DB

public static final ContextConstants DB

Database connection or session reserved for this transaction.

TX

public static final ContextConstants TX

Database transaction handle, when applicable.

IRC

public static final ContextConstants IRC

International response code resolved during processing.

TXNNAME

public static final ContextConstants TXNNAME

Logical transaction name.

RESULT

public static final ContextConstants RESULT

Final Result of the transaction.

MID

public static final ContextConstants MID

Merchant identifier.

TID

public static final ContextConstants TID

Terminal identifier.

PCODE

public static final ContextConstants PCODE

Processing code.

CARD

public static final ContextConstants CARD

Cardholder/card data captured by the transaction.

TRANSMISSION_TIMESTAMP

public static final ContextConstants TRANSMISSION_TIMESTAMP

Transmission timestamp from the inbound message.

TRANSACTION_TIMESTAMP

public static final ContextConstants TRANSACTION_TIMESTAMP

Transaction timestamp from the inbound message.

CAPTURE_DATE

public static final ContextConstants CAPTURE_DATE

Capture date for clearing/settlement.

POS_DATA_CODE

public static final ContextConstants POS_DATA_CODE

POS data code describing the entry environment.

AMOUNT

public static final ContextConstants AMOUNT

Settlement/transaction amount.

LOCAL_AMOUNT

public static final ContextConstants LOCAL_AMOUNT

Cardholder-billing amount in the cardholder's local currency.

ORIGINAL_MTI

public static final ContextConstants ORIGINAL_MTI

MTI of the original message, when echoing or reversing.

ORIGINAL_STAN

public static final ContextConstants ORIGINAL_STAN

STAN of the original message, when echoing or reversing.

ORIGINAL_TIMESTAMP

public static final ContextConstants ORIGINAL_TIMESTAMP

Transmission timestamp of the original message.

ORIGINAL_DATA_ELEMENTS

public static final ContextConstants ORIGINAL_DATA_ELEMENTS

Data elements echoed from the original message.

DESTINATION

public static final ContextConstants DESTINATION

Routing destination chosen for the transaction.

PANIC

public static final ContextConstants PANIC

Panic flag indicating the transaction must abort immediately.

Method Details

values

public static ContextConstants[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ContextConstants valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ContextConstants>