Class XMLPackager

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.jpos.iso.packager.XMLPackager

All Implemented Interfaces:

ISOPackager, LogSource, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

XML2003Packager

public class XMLPackager
extends DefaultHandler
implements ISOPackager, LogSource

packs/unpacks ISOMsgs into XML representation

See Also:

• ISOPackager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASCII_ENCODING	Literal name for ASCII encoding declarations.
static final String	CURRENCY_ATTR	XML attribute name holding currency metadata.
static final String	DATASET_TAG	XML element name used for datasets.
static final String	ELEMENT_TAG	XML element name used for dataset elements.
static final String	ENCODING_ATTR	XML attribute name used for charset declarations.
static final String	FORMAT_ATTR	XML attribute name holding dataset format metadata.
static final String	HEADER_TAG	XML element name used for message headers.
static final String	ID_ATTR	XML attribute name holding field identifiers.
static final String	ISOFIELD_TAG	XML element name used for ISO fields.
static final String	ISOMSG_TAG	XML element name used for ISO messages.
protected Logger	logger	Logger used to emit pack/unpack events.
protected String	realm	Logging realm associated with this packager.
static final String	TYPE_AMOUNT	XML type marker for amount field content.
static final String	TYPE_ATTR	XML attribute name holding type metadata.
static final String	TYPE_BINARY	XML type marker for binary field content.
static final String	TYPE_BITMAP	XML type marker for bitmap field content.
static final String	TYPE_DATASET	XML type marker for dataset field content.
static final String	VALUE_ATTR	XML attribute name holding scalar values.

Constructor Summary

Constructors

Constructor	Description
XMLPackager()	Creates an XML packager with a hardened SAX parser configuration.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
ISOMsg	createISOMsg()	Creates and returns a new ISOMsg instance appropriate for this packager.
protected XMLReader	createXMLReader()	Creates the SAX reader used to parse XML ISO messages.
void	endElement(String ns, String name, String qname)
protected void	fixupBinary(ISOMsg m, int[] bfields)	Converts selected message fields from hexadecimal strings into binary values.
void	forceBinary(int... bfields)	Marks the supplied fields so their XML values are always decoded as binary.
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	setXMLParserFeature(String fname, boolean val)	Sets a SAX feature on the underlying XML parser.
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

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 used to emit pack/unpack events.

realm

protected String realm

Logging realm associated with this packager.

ISOMSG_TAG

public static final String ISOMSG_TAG

XML element name used for ISO messages.

See Also:

• Constant Field Values

ISOFIELD_TAG

public static final String ISOFIELD_TAG

XML element name used for ISO fields.

See Also:

• Constant Field Values

ID_ATTR

public static final String ID_ATTR

XML attribute name holding field identifiers.

See Also:

• Constant Field Values

VALUE_ATTR

public static final String VALUE_ATTR

XML attribute name holding scalar values.

See Also:

• Constant Field Values

TYPE_ATTR

public static final String TYPE_ATTR

XML attribute name holding type metadata.

See Also:

• Constant Field Values

TYPE_BINARY

public static final String TYPE_BINARY

XML type marker for binary field content.

See Also:

• Constant Field Values

TYPE_BITMAP

public static final String TYPE_BITMAP

XML type marker for bitmap field content.

See Also:

• Constant Field Values

TYPE_AMOUNT

public static final String TYPE_AMOUNT

XML type marker for amount field content.

See Also:

• Constant Field Values

TYPE_DATASET

public static final String TYPE_DATASET

XML type marker for dataset field content.

See Also:

• Constant Field Values

CURRENCY_ATTR

public static final String CURRENCY_ATTR

XML attribute name holding currency metadata.

See Also:

• Constant Field Values

HEADER_TAG

public static final String HEADER_TAG

XML element name used for message headers.

See Also:

• Constant Field Values

ENCODING_ATTR

public static final String ENCODING_ATTR

XML attribute name used for charset declarations.

See Also:

• Constant Field Values

ASCII_ENCODING

public static final String ASCII_ENCODING

Literal name for ASCII encoding declarations.

See Also:

• Constant Field Values

DATASET_TAG

public static final String DATASET_TAG

XML element name used for datasets.

See Also:

• Constant Field Values

ELEMENT_TAG

public static final String ELEMENT_TAG

XML element name used for dataset elements.

See Also:

• Constant Field Values

FORMAT_ATTR

public static final String FORMAT_ATTR

XML attribute name holding dataset format metadata.

See Also:

• Constant Field Values

Constructor Details

XMLPackager

public XMLPackager()
            throws ISOException

Creates an XML packager with a hardened SAX parser configuration.

Throws:

ISOException - if the XML reader cannot be created or configured

Method Details

forceBinary

public void forceBinary(int... bfields)

Marks the supplied fields so their XML values are always decoded as binary.

Parameters:

bfields - field numbers to force as binary

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

characters

public void characters(char[] ch,
 int start,
 int length)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

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

fixupBinary

protected void fixupBinary(ISOMsg m,
 int[] bfields)
                    throws ISOException

Converts selected message fields from hexadecimal strings into binary values.

Parameters:

m - message being adjusted

bfields - field numbers to convert

Throws:

ISOException - if any field cannot be converted

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

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

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

createXMLReader

protected XMLReader createXMLReader()
                             throws SAXException

Creates the SAX reader used to parse XML ISO messages.

Returns:

configured XML reader instance

Throws:

SAXException - if the reader cannot be created

setXMLParserFeature

public void setXMLParserFeature(String fname,
 boolean val)
                         throws SAXException

Sets a SAX feature on the underlying XML parser.

Parameters:

fname - feature name URI

val - feature value to apply

Throws:

SAXException - if the parser rejects the feature