Class Base1SubFieldPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.Base1SubFieldPackager

All Implemented Interfaces:

ISOPackager, LogSource

Direct Known Subclasses:

Base1Packager.F126Packager

public class Base1SubFieldPackager
extends ISOBasePackager

ISO 8583 v1987 BINARY Packager customized for VISA Base1 subfields

See Also:

• ISOPackager
• ISOBasePackager
• ISOComponent

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected boolean	emitBitMap()	Indicates whether a primary bitmap is emitted on pack.
protected ISOFieldPackager	getBitMapfieldPackager()	Returns the field packager used for the primary bitmap.
protected int	getFirstField()	usually 2 for normal fields, 1 for bitmap-less or ANSI X9.2
byte[]	pack(ISOComponent m)	Pack the subfield into a byte array
int	unpack(ISOComponent m, byte[] b)	Unpack a packed subfield into its corresponding ISOComponent

Methods inherited from class ISOBasePackager

createISOMsg, fieldUnpackLogger, getDescription, getFieldDescription, getFieldPackager, getHeaderLength, getLogger, getMaxValidField, getRealm, getThirdBitmapField, setFieldPackager, setFieldPackager, setHeaderLength, setLogger, 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.
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.
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	setLogger(Logger logger, String realm)	Attaches a Logger and realm to this log source.
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

Constructor Details

Base1SubFieldPackager

public Base1SubFieldPackager()

Default constructor; no instance state to initialise.

Method Details

emitBitMap

protected boolean emitBitMap()

Description copied from class: ISOBasePackager

Indicates whether a primary bitmap is emitted on pack.

Overrides:

emitBitMap in class ISOBasePackager

Returns:

true if the field-1 packager is an ISOBitMapPackager

getFirstField

protected int getFirstField()

Description copied from class: ISOBasePackager

usually 2 for normal fields, 1 for bitmap-less or ANSI X9.2

Overrides:

getFirstField in class ISOBasePackager

Returns:

first valid field

getBitMapfieldPackager

protected ISOFieldPackager getBitMapfieldPackager()

Description copied from class: ISOBasePackager

Returns the field packager used for the primary bitmap.

Overrides:

getBitMapfieldPackager in class ISOBasePackager

Returns:

suitable ISOFieldPackager for Bitmap

unpack

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

Unpack a packed subfield into its corresponding ISOComponent

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

pack

public byte[] pack(ISOComponent m)
            throws ISOException

Pack the subfield into a byte array

Specified by:

pack in interface ISOPackager

Overrides:

pack in class ISOBasePackager

Parameters:

m - the Component to pack

Returns:

Message image

Throws:

ISOException - if the component cannot be packed