Class ICCDataPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.GenericPackager

org.jpos.iso.packager.DatasetPackager

org.jpos.iso.packager.ICCDataPackager

All Implemented Interfaces:

Configurable, ISODatasetPackager, ISOPackager, ISOSubFieldPackager, GenericPackagerParams, LogSource

public class ICCDataPackager
extends DatasetPackager

Special-case packager for DE 055 ICC data, which carries raw BER-TLV without the standard dataset identifier and length envelope.

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
ICCDataPackager()	Creates an ICC data packager.

Method Summary

Modifier and Type	Method	Description
boolean	hasDatasetEnvelope()	ICC data is encoded as raw BER-TLV, without the standard dataset identifier and length envelope.
byte[]	pack(ISOComponent m)	Packs raw ICC BER-TLV bytes without the standard dataset envelope.
int	unpack(ISOComponent m, byte[] b)	Unpacks raw ICC BER-TLV bytes into a synthetic dataset keyed by the outer field number.
void	unpack(ISOComponent m, InputStream in)	Unpacks raw ICC BER-TLV bytes from a stream.

Methods inherited from class DatasetPackager

getFieldNumber, packDatasetContent, packDBM, packTLV, resolveDatasetFormat, setGenericPackagerParams, unpackDataset, unpackDBM, unpackTLV

Modifier and Type	Method	Description
int	getFieldNumber()	Returns the outer ISO field number this dataset packager is bound to.
protected byte[]	packDatasetContent(Dataset dataset)	Packs the inner dataset payload without the outer dataset envelope.
protected byte[]	packDBM(Dataset dataset)	Encodes a DBM dataset payload.
protected byte[]	packTLV(Dataset dataset)	Encodes a TLV dataset payload.
protected DatasetFormat	resolveDatasetFormat(int identifier)	Resolves the format implied by a dataset identifier.
void	setGenericPackagerParams(Attributes atts)	Captures the outer field id declared in the XML packager definition.
protected Dataset	unpackDataset(int identifier, DatasetFormat format, byte[] content)	Decodes a dataset payload without the outer dataset envelope.
protected ISODataset	unpackDBM(int identifier, byte[] content)	Decodes a DBM dataset payload.
protected ISODataset	unpackTLV(int identifier, byte[] content)	Decodes a TLV dataset payload.

Methods inherited from class GenericPackager

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

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	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

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.

Methods inherited from class Object

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

Constructor Details

ICCDataPackager

public ICCDataPackager()
                throws ISOException

Creates an ICC data packager.

Throws:

ISOException - on packager initialization errors

Method Details

hasDatasetEnvelope

public boolean hasDatasetEnvelope()

ICC data is encoded as raw BER-TLV, without the standard dataset identifier and length envelope.

Returns:

always false

pack

public byte[] pack(ISOComponent m)
            throws ISOException

Packs raw ICC BER-TLV bytes without the standard dataset envelope.

Specified by:

pack in interface ISOPackager

Overrides:

pack in class DatasetPackager

Parameters:

m - ICC dataset field

Returns:

packed BER-TLV bytes

Throws:

ISOException - on packing errors

unpack

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

Unpacks raw ICC BER-TLV bytes into a synthetic dataset keyed by the outer field number.

Specified by:

unpack in interface ISOPackager

Overrides:

unpack in class DatasetPackager

Parameters:

m - destination dataset field

b - BER-TLV bytes

Returns:

number of bytes consumed

Throws:

ISOException - on unpacking errors

unpack

public void unpack(ISOComponent m,
 InputStream in)
            throws IOException,
ISOException

Unpacks raw ICC BER-TLV bytes from a stream.

Specified by:

unpack in interface ISOPackager

Overrides:

unpack in class DatasetPackager

Parameters:

m - destination dataset field

in - source stream

Throws:

IOException - on stream errors

ISOException - on unpacking errors