Class GenericPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.GenericPackager

All Implemented Interfaces:

Configurable, ISOPackager, GenericPackagerParams, LogSource

Direct Known Subclasses:

BERTLVPackager, DatasetPackager, GenericSubFieldPackager, GenericTaggedFieldsPackager, GenericValidatingPackager, GICCSubFieldPackager, TaggedSequencePackager, X92GenericPackager

public class GenericPackager
extends ISOBasePackager
implements Configurable, GenericPackagerParams

GenericPackager uses an XML config file to describe the layout of an ISOMessage
The general format is as follows
<isopackager>
    <isofield
        id="[field id]"
        name="[field name]"
        length="[max field length]"
        class="[org.jpos.iso.IF_*]"
        pad="true|false">
    </isofield>
    ...
</isopackager>

Fields that contain subfields can be handled as follows
<isofieldpackager
    id="[field id]"
    name="[field name]"
    length="[field length]"
    class="[org.jpos.iso.IF_*]"
    packager="[org.jpos.iso.packager.*]">

    <isofield
        id="[subfield id]"
        name="[subfield name]"
        length="[max subfield length]"
        class="[org.jpos.iso.IF_*]"
        pad="true|false">
    </isofield>
        ...
</isofieldpackager>

The optional attributes maxValidField, bitmapField, thirdBitmapField, and emitBitmap
are allowed on the isopackager node.

See Also:

• ISOPackager
• ISOBasePackager

Nested Class Summary

Nested Classes

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 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
GenericPackager()	Default constructor.
GenericPackager(InputStream input)	Create a GenericPackager with the field descriptions from an XML InputStream
GenericPackager(String filename)	Create a GenericPackager with the field descriptions from an XML File

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.
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
protected int	getMaxValidField()	Returns the highest valid field number for this packager.
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

Constructor Details

GenericPackager

public GenericPackager()
                throws ISOException

Default constructor.

Throws:

ISOException - if the underlying packager cannot be initialized

GenericPackager

public GenericPackager(String filename)
                throws ISOException

Create a GenericPackager with the field descriptions from an XML File

Parameters:

filename - The XML field description file

Throws:

ISOException - if the field description file cannot be read or parsed

GenericPackager

public GenericPackager(InputStream input)
                throws ISOException

Create a GenericPackager with the field descriptions from an XML InputStream

Parameters:

input - The XML field description InputStream

Throws:

ISOException - if the input stream cannot be read or parsed

Method Details

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException

Packager Configuration.

• packager-config
• packager-logger
• packager-log-fieldname
• packager-realm

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - Configuration

Throws:

ConfigurationException - if the configuration is invalid

getMaxValidField

protected int getMaxValidField()

Description copied from class: ISOBasePackager

Returns the highest valid field number for this packager.

Overrides:

getMaxValidField in class ISOBasePackager

Returns:

128 for ISO-8583, should return 64 for ANSI X9.2

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

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

readFile

public void readFile(String filename)
              throws ISOException

Parse the field descriptions from an XML file.

Uses the sax parser specified by the system property 'sax.parser'
The default parser is org.apache.crimson.parser.XMLReaderImpl

Parameters:

filename - The XML field description file

Throws:

ISOException - if the file cannot be read or parsed

readFile

public void readFile(InputStream input)
              throws ISOException

Parse the field descriptions from an XML InputStream.

Uses the sax parser specified by the system property 'sax.parser'
The default parser is org.apache.crimson.parser.XMLReaderImpl

Parameters:

input - The XML field description InputStream

Throws:

ISOException - if the stream cannot be read or parsed

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)

getDescription

public String getDescription()

Description copied from interface: ISOPackager

Returns a human-readable description of this packager.

Specified by:

getDescription in interface ISOPackager

Overrides:

getDescription in class ISOBasePackager

Returns:

Packager's Description

setGenericPackagerParams

public void setGenericPackagerParams(Attributes atts)

Description copied from interface: GenericPackagerParams

Applies packager configuration from the SAX attributes of the packager XML element.

Specified by:

setGenericPackagerParams in interface GenericPackagerParams

Parameters:

atts - the SAX attributes from the packager element

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