Class BERTLVPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.GenericPackager

org.jpos.tlv.packager.bertlv.BERTLVPackager

All Implemented Interfaces:

Configurable, ISOPackager, GenericPackagerParams, LogSource

Direct Known Subclasses:

DefaultICCBERTLVPackager

public abstract class BERTLVPackager
extends GenericPackager

Packager for ISO 8825 BER TLV values.

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

Method Summary

Modifier and Type	Method	Description
protected abstract BinaryInterpreter	getLengthInterpreter()	Returns the interpreter used for encoding/decoding length bytes.
protected abstract BERTLVFormatMapper	getTagFormatMapper()	Returns the format mapper for this packager's tag set.
protected abstract BinaryInterpreter	getTagInterpreter()	Returns the interpreter used for encoding/decoding tag bytes.
protected abstract BinaryInterpreter	getValueInterpreter()	Returns the interpreter used for encoding/decoding value bytes.
byte[]	pack(ISOComponent m)	Pack the sub-field into a byte array
byte[]	pack(ISOComponent m, boolean nested, int startIdx, int endIdx)	Packs a subset of sub-fields.
protected byte[]	packValue(String tagNameHex, ISOComponent c)	Packs a single TLV value field.
int	unpack(ISOComponent m, byte[] b)	Unpacks an ISO-8583 byte array into the given message container.
int	unpack(ISOComponent m, byte[] b, boolean nested)	Unpacks BER-TLV encoded data.
void	unpack(ISOComponent m, InputStream in)	Unpacks an ISO-8583 message from an input stream into the given container.

Methods inherited from class GenericPackager

emitBitMap, getBitMapfieldPackager, getDescription, getFirstField, getMaxValidField, readFile, readFile, setConfiguration, setGenericPackagerParams, 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	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, 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

BERTLVPackager

public BERTLVPackager()
               throws ISOException

Default constructor.

Throws:

ISOException - on configuration error

Method Details

getTagInterpreter

protected abstract BinaryInterpreter getTagInterpreter()

Returns the interpreter used for encoding/decoding tag bytes.

Returns:

tag byte interpreter

getLengthInterpreter

protected abstract BinaryInterpreter getLengthInterpreter()

Returns the interpreter used for encoding/decoding length bytes.

Returns:

length byte interpreter

getValueInterpreter

protected abstract BinaryInterpreter getValueInterpreter()

Returns the interpreter used for encoding/decoding value bytes.

Returns:

value byte interpreter

getTagFormatMapper

protected abstract BERTLVFormatMapper getTagFormatMapper()

Returns the format mapper for this packager's tag set.

Returns:

BER-TLV format mapper

pack

public byte[] pack(ISOComponent m)
            throws ISOException

Pack the sub-field 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

pack

public byte[] pack(ISOComponent m,
 boolean nested,
 int startIdx,
 int endIdx)
            throws ISOException

Packs a subset of sub-fields.

Parameters:

m - the ISO component to pack

nested - true if this is a nested (inner) pack

startIdx - first field index to include

endIdx - last field index to include

Returns:

packed bytes

Throws:

ISOException - on packing error

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

unpack

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

Unpacks BER-TLV encoded data.

Parameters:

m - target component

b - packed bytes

nested - true for nested unpack

Returns:

consumed bytes

Throws:

ISOException - on unpacking error

packValue

protected byte[] packValue(String tagNameHex,
 ISOComponent c)
                    throws ISOException,
UnknownTagNumberException

Packs a single TLV value field. Packs the value of the given component for the specified tag.

Parameters:

tagNameHex - the tag name as a hex string

c - the component to pack

Returns:

packed value bytes

Throws:

ISOException - on packing error

UnknownTagNumberException - if the tag is not recognised

unpack

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

Description copied from interface: ISOPackager

Unpacks an ISO-8583 message from an input stream into the given container.

Specified by:

unpack in interface ISOPackager

Overrides:

unpack in class ISOBasePackager

Parameters:

m - the container

in - the input stream

Throws:

IOException - on I/O failure

ISOException - on unpacking error