Class LogPackager

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.jpos.iso.packager.LogPackager

All Implemented Interfaces:

ISOPackager, LogSource, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class LogPackager
extends DefaultHandler
implements ISOPackager, LogSource

packs/unpacks ISOMsgs from jPOS logs

See Also:

• ISOPackager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_ATTR	XML attribute carrying the field number.
static final String	ISOFIELD_TAG	XML element name for an ISO field.
static final String	ISOMSG_TAG	XML element name for an ISO message.
static final String	LOG_TAG	XML element name for the outer log wrapper.
protected Logger	logger	Logger receiving pack/unpack diagnostic events.
protected String	realm	Logger realm associated with this packager.
static final String	TYPE_ATTR	XML attribute identifying the field type (TYPE_BINARY, TYPE_BITMAP).
static final String	TYPE_BINARY	Field-type marker: hex-encoded binary value.
static final String	TYPE_BITMAP	Field-type marker: bitmap value.
static final String	VALUE_ATTR	XML attribute carrying the field value.

Constructor Summary

Constructors

Constructor	Description
LogPackager()	Constructs the packager and prepares its underlying SAX parser.

Method Summary

Modifier and Type	Method	Description
ISOMsg	createISOMsg()	Creates and returns a new ISOMsg instance appropriate for this packager.
void	endElement(String ns, String name, String qname)
String	getDescription()	Returns a human-readable description of this packager.
String	getFieldDescription(ISOComponent m, int fldNumber)	Emits a description of the field identified by fldno in the given message to the log event.
Logger	getLogger()	Returns the Logger associated with this source.
String	getRealm()	Returns the log realm associated with this source.
byte[]	pack(ISOComponent c)	Packs an ISO-8583 message into a byte array.
void	setLogger(Logger logger, String realm)	Attaches a Logger and realm to this log source.
void	startElement(String ns, String name, String qName, Attributes atts)
int	unpack(ISOComponent c, byte[] b)	Unpacks an ISO-8583 byte array into the given message container.
void	unpack(ISOComponent c, InputStream in)	Unpacks an ISO-8583 message from an input stream into the given container.

Methods inherited from class DefaultHandler

characters, endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Field Details

logger

protected Logger logger

Logger receiving pack/unpack diagnostic events.

realm

protected String realm

Logger realm associated with this packager.

LOG_TAG

public static final String LOG_TAG

XML element name for the outer log wrapper.

See Also:

• Constant Field Values

ISOMSG_TAG

public static final String ISOMSG_TAG

XML element name for an ISO message.

See Also:

• Constant Field Values

ISOFIELD_TAG

public static final String ISOFIELD_TAG

XML element name for an ISO field.

See Also:

• Constant Field Values

ID_ATTR

public static final String ID_ATTR

XML attribute carrying the field number.

See Also:

• Constant Field Values

VALUE_ATTR

public static final String VALUE_ATTR

XML attribute carrying the field value.

See Also:

• Constant Field Values

TYPE_ATTR

public static final String TYPE_ATTR

XML attribute identifying the field type (TYPE_BINARY, TYPE_BITMAP).

See Also:

• Constant Field Values

TYPE_BINARY

public static final String TYPE_BINARY

Field-type marker: hex-encoded binary value.

See Also:

• Constant Field Values

TYPE_BITMAP

public static final String TYPE_BITMAP

Field-type marker: bitmap value.

See Also:

• Constant Field Values

Constructor Details

LogPackager

public LogPackager()
            throws ISOException

Constructs the packager and prepares its underlying SAX parser.

Throws:

ISOException - if the configured SAX parser cannot be instantiated

Method Details

pack

public byte[] pack(ISOComponent c)
            throws ISOException

Description copied from interface: ISOPackager

Packs an ISO-8583 message into a byte array.

Specified by:

pack in interface ISOPackager

Parameters:

c - the Component to pack

Returns:

Message image

Throws:

ISOException - on packing error

unpack

public int unpack(ISOComponent c,
 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

Parameters:

c - the Container of this message

b - ISO message image

Returns:

consumed bytes

Throws:

ISOException - on unpacking error

unpack

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

Description copied from interface: ISOPackager

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

Specified by:

unpack in interface ISOPackager

Parameters:

c - the container

in - the input stream

Throws:

ISOException - on unpacking error

IOException - on I/O failure

startElement

public void startElement(String ns,
 String name,
 String qName,
 Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String ns,
 String name,
 String qname)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

getFieldDescription

public String getFieldDescription(ISOComponent m,
 int fldNumber)

Description copied from interface: ISOPackager

Emits a description of the field identified by fldno in the given message to the log event.

Specified by:

getFieldDescription in interface ISOPackager

Parameters:

m - the Container (i.e. an ISOMsg)

fldNumber - the Field Number

Returns:

Field Description

getDescription

public String getDescription()

Description copied from interface: ISOPackager

Returns a human-readable description of this packager.

Specified by:

getDescription in interface ISOPackager

Returns:

Packager's Description

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

Parameters:

logger - the logger to use

realm - the log realm (diagnostic label)

getRealm

public String getRealm()

Description copied from interface: LogSource

Returns the log realm associated with this source.

Specified by:

getRealm in interface LogSource

Returns:

log realm

getLogger

public Logger getLogger()

Description copied from interface: LogSource

Returns the Logger associated with this source.

Specified by:

getLogger in interface LogSource

Returns:

the Logger

createISOMsg

public ISOMsg createISOMsg()

Description copied from interface: ISOPackager

Creates and returns a new ISOMsg instance appropriate for this packager.

Specified by:

createISOMsg in interface ISOPackager

Returns:

a new ISOMsg