Class EuroSubFieldPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.EuroSubFieldPackager

All Implemented Interfaces:

ISOPackager, LogSource

Direct Known Subclasses:

EuroPackager.Euro48Packager, MasterCardEBCDICSubFieldPackager

public class EuroSubFieldPackager
extends ISOBasePackager

EuroPay SubField packager

See Also:

• ISOPackager
• ISOBasePackager
• This packager is used by EuroPackager to package subfields such as field 48.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Prefixer	tagPrefixer	Length prefixer used to pack/unpack each Euro subfield's tag.

Fields inherited from class ISOBasePackager

fld, headerLength, logFieldName, logger, realm, thirdBitmapField

Modifier and Type	Field	Description
protected ISOFieldPackager[]	fld	Per-field packagers indexed by field number.
protected int	headerLength	Number of leading bytes treated as the ISO header during unpack.
protected boolean	logFieldName	When true, field descriptions are emitted as XML comments in unpack logs.
protected Logger	logger	Logger used to record pack/unpack diagnostics; null disables logging.
protected String	realm	Logger realm associated with this packager.
protected int	thirdBitmapField	Field number that carries the tertiary bitmap as a Data Element, or -999 if not used.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected boolean	emitBitMap()	Always return false
byte[]	pack(ISOComponent c)	pack method that works in conjunction with ISOBasePackager.unpack(ISOComponent, byte[]).
void	setLogger(Logger logger, String realm)	Attaches a Logger and realm to this log source.
int	unpack(ISOComponent m, byte[] b)	This packager treats field 0 as a field that may or may not be present before the TLV subelements.

Methods inherited from class ISOBasePackager

createISOMsg, fieldUnpackLogger, getBitMapfieldPackager, getDescription, getFieldDescription, getFieldPackager, getFirstField, getHeaderLength, getLogger, getMaxValidField, getRealm, getThirdBitmapField, setFieldPackager, setFieldPackager, setHeaderLength, setThirdBitmapField, unpack

Modifier and Type	Method	Description
ISOMsg	createISOMsg()	Factory hook returning the ISOMsg subclass produced during unpack.
protected static void	fieldUnpackLogger(LogEvent evt, int fldno, ISOComponent c, ISOFieldPackager fld, boolean logFieldName)	Internal helper logging function.
protected ISOFieldPackager	getBitMapfieldPackager()	Returns the field packager used for the primary bitmap.
String	getDescription()	Returns a human-readable description of this packager.
String	getFieldDescription(ISOComponent m, int fldNumber)	Returns the human-readable description of a field as defined by its packager.
ISOFieldPackager	getFieldPackager(int fldNumber)	Returns the field packager registered for the given field number.
protected int	getFirstField()	usually 2 for normal fields, 1 for bitmap-less or ANSI X9.2
int	getHeaderLength()	Returns the configured ISO header length in bytes.
Logger	getLogger()	Returns the Logger associated with this source.
protected int	getMaxValidField()	Returns the highest valid field number for this packager.
String	getRealm()	Returns the log realm associated with this source.
int	getThirdBitmapField()	Returns the field number carrying the tertiary bitmap as a Data Element.
void	setFieldPackager(int fldNumber, ISOFieldPackager fieldPackager)	Replaces the packager registered for a single field.
void	setFieldPackager(ISOFieldPackager[] fld)	Replaces the per-field packager array.
void	setHeaderLength(int len)	Sets the ISO header length in bytes.
void	setThirdBitmapField(int f)	Configures the Data Element field that holds the tertiary bitmap.
void	unpack(ISOComponent m, InputStream in)	Unpacks an ISO-8583 message from an input stream into the given container.

Methods inherited from class Object

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

Field Details

tagPrefixer

protected static Prefixer tagPrefixer

Length prefixer used to pack/unpack each Euro subfield's tag.

Constructor Details

EuroSubFieldPackager

public EuroSubFieldPackager()

Default constructor; no instance state to initialise.

Method Details

emitBitMap

protected boolean emitBitMap()

Always return false

Overrides:

emitBitMap in class ISOBasePackager

Returns:

true if the field-1 packager is an ISOBitMapPackager

pack

public byte[] pack(ISOComponent c)
            throws ISOException

Description copied from class: ISOBasePackager

pack method that works in conjunction with ISOBasePackager.unpack(ISOComponent, byte[]).

Handles a tertiary bitmap possibly appearing in Data Element thirdBitmapField.

Specified by:

pack in interface ISOPackager

Overrides:

pack in class ISOBasePackager

Parameters:

c - the Component to pack

Returns:

Message image

Throws:

ISOException - if the component cannot be packed

unpack

public int unpack(ISOComponent m,
 byte[] b)
           throws ISOException

This packager treats field 0 as a field that may or may not be present before the TLV subelements. Certain types of messages for some 8583 specs that extend this class' behavior (e.g., the Mastercard implementation in class MasterCardEBCDICSubFieldPackager) may not have field 0 present (the TCC in Mastercard's nomenclature). So, if the corresponding isofield packager for field 0 doesn't fill the ISOComponent's value, we don't store anything as subfield 0 of m.

Specified by:

unpack in interface ISOPackager

Overrides:

unpack in class ISOBasePackager

Parameters:

m - the Container of this message

b - ISO message image

Returns:

consumed bytes

Throws:

ISOException - if the message image cannot be unpacked

setLogger

public void setLogger(Logger logger,
 String realm)

Description copied from interface: LogSource

Attaches a Logger and realm to this log source.

Specified by:

setLogger in interface LogSource

Overrides:

setLogger in class ISOBasePackager

Parameters:

logger - the logger to use

realm - the log realm (diagnostic label)