Class X92GenericPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.GenericPackager

org.jpos.iso.packager.X92GenericPackager

All Implemented Interfaces:

Configurable, ISOPackager, GenericPackagerParams, LogSource

public class X92GenericPackager
extends GenericPackager

ISO-8583 packager for the X9.2 generic message format.

See Also:

• GenericPackager

Nested Class Summary

Nested classes/interfaces inherited from class GenericPackager

GenericPackager.GenericContentHandler, GenericPackager.GenericEntityResolver

Modifier and Type	Class	Description
class	GenericPackager.GenericContentHandler	SAX content handler that builds the packager's field structure from the DTD-driven XML.
static class	GenericPackager.GenericEntityResolver	SAX entity resolver that maps the GenericPackager DTD URIs to bundled resources.

Field Summary

Fields

Modifier and Type	Field	Description
protected static ISOFieldPackager	bitMapPackager	Shared bitmap packager used by X9.2 messages.

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
X92GenericPackager()	Default constructor.
X92GenericPackager(InputStream stream)	Constructs a packager loading its field descriptions from an XML stream.
X92GenericPackager(String filename)	Constructs a packager loading its field descriptions from an XML file.

Method Summary

Modifier and Type	Method	Description
protected boolean	emitBitMap()	Although field 1 is not a Bitmap ANSI X9.2 do have a Bitmap field that have to be packed/unpacked
protected ISOFieldPackager	getBitMapfieldPackager()	Returns the field packager used for the primary bitmap.
protected int	getMaxValidField()	Returns the highest valid field number for this packager.

Methods inherited from class GenericPackager

getDescription, getFirstField, readFile, readFile, setConfiguration, setGenericPackagerParams, setLogger

Modifier and Type	Method	Description
String	getDescription()	Returns a human-readable description of this packager.
protected int	getFirstField()	usually 2 for normal fields, 1 for bitmap-less or ANSI X9.2
void	readFile(InputStream input)	Parse the field descriptions from an XML InputStream.
void	readFile(String filename)	Parse the field descriptions from an XML file.
void	setConfiguration(Configuration cfg)	Packager Configuration.
void	setGenericPackagerParams(Attributes atts)	Applies packager configuration from the SAX attributes of the packager XML element.
void	setLogger(Logger logger, String realm)	Attaches a Logger and realm to this log source.

Methods inherited from class ISOBasePackager

createISOMsg, fieldUnpackLogger, getFieldDescription, getFieldPackager, getHeaderLength, getLogger, getRealm, getThirdBitmapField, pack, setFieldPackager, setFieldPackager, setHeaderLength, setThirdBitmapField, unpack, 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	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.
String	getRealm()	Returns the log realm associated with this source.
int	getThirdBitmapField()	Returns the field number carrying the tertiary bitmap as a Data Element.
byte[]	pack(ISOComponent m)	pack method that works in conjunction with ISOBasePackager.unpack(ISOComponent, byte[]).
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.
int	unpack(ISOComponent m, byte[] b)	Unpacks an ISO-8583 byte array into the given message container.
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

bitMapPackager

protected static ISOFieldPackager bitMapPackager

Shared bitmap packager used by X9.2 messages.

Constructor Details

X92GenericPackager

public X92GenericPackager()
                   throws ISOException

Default constructor.

Throws:

ISOException - if the underlying packager cannot be initialized

X92GenericPackager

public X92GenericPackager(String filename)
                   throws ISOException

Constructs a packager loading its field descriptions from an XML file.

Parameters:

filename - XML descriptor file

Throws:

ISOException - if the file cannot be read or parsed

X92GenericPackager

public X92GenericPackager(InputStream stream)
                   throws ISOException

Constructs a packager loading its field descriptions from an XML stream.

Parameters:

stream - XML descriptor input stream

Throws:

ISOException - if the stream cannot be read or parsed

Method Details

getBitMapfieldPackager

protected ISOFieldPackager getBitMapfieldPackager()

Description copied from class: ISOBasePackager

Returns the field packager used for the primary bitmap.

Overrides:

getBitMapfieldPackager in class GenericPackager

Returns:

Bitmap's ISOFieldPackager

emitBitMap

protected boolean emitBitMap()

Although field 1 is not a Bitmap ANSI X9.2 do have a Bitmap field that have to be packed/unpacked

Overrides:

emitBitMap in class GenericPackager

Returns:

true

See Also:

• ISOBasePackager

getMaxValidField

protected int getMaxValidField()

Description copied from class: ISOBasePackager

Returns the highest valid field number for this packager.

Overrides:

getMaxValidField in class GenericPackager

Returns:

64 for ANSI X9.2