Class GICCSubFieldPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.GenericPackager

org.jpos.iso.packager.GICCSubFieldPackager

All Implemented Interfaces:

Configurable, ISOPackager, ISOSubFieldPackager, GenericPackagerParams, LogSource

public class GICCSubFieldPackager
extends GenericPackager
implements ISOSubFieldPackager, GenericPackagerParams

This packager is used to package subfields such as field 60 of GICC.

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 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
GICCSubFieldPackager()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	emitBitMap()	Always return false
int	getFieldNumber()	Get current composite field number
byte[]	pack(ISOComponent c)	pack method that works in conjunction with ISOBasePackager.unpack(ISOComponent, byte[]).
void	setGenericPackagerParams(Attributes atts)	Applies packager configuration from the SAX attributes of the packager XML element.
int	unpack(ISOComponent m, byte[] b)	Unpacks an ISO-8583 byte array into the given message container.

Methods inherited from class GenericPackager

getBitMapfieldPackager, getDescription, getFirstField, getMaxValidField, readFile, readFile, setConfiguration, setLogger

Modifier and Type	Method	Description
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	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, 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.
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.
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

Constructor Details

GICCSubFieldPackager

public GICCSubFieldPackager()
                     throws ISOException

Default constructor.

Throws:

ISOException - if configuration fails

Method Details

emitBitMap

protected boolean emitBitMap()

Always return false

Overrides:

emitBitMap in class GenericPackager

Returns:

true if the field-1 packager is an ISOBitMapPackager

getFieldNumber

public int getFieldNumber()

Description copied from interface: ISOSubFieldPackager

Get current composite field number

Specified by:

getFieldNumber in interface ISOSubFieldPackager

Returns:

composite field number

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

Overrides:

setGenericPackagerParams in class GenericPackager

Parameters:

atts - the SAX attributes from the packager element

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

Description copied from interface: ISOPackager

Unpacks an ISO-8583 byte array into the given message container.

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