Class GenericValidatingPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.GenericPackager

org.jpos.iso.packager.GenericValidatingPackager

All Implemented Interfaces:

Configurable, ISOPackager, ISOValidator, GenericPackagerParams, LogSource

public class GenericValidatingPackager
extends GenericPackager
implements ISOValidator

Generic Packager that configure validators too.

Title: jPOS

Description: Java Framework for Financial Systems

Copyright: Copyright (c) 2000 jPOS.org. All rights reserved.

Company: www.jPOS.org

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	GenericValidatingPackager.GenericValidatorContentHandler	SAX handler that builds the packager's field-and-validator graph from the descriptor XML.

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

Modifier and Type	Field	Description
protected int	bitmapField	Field number that carries the primary bitmap; overridable via XML.
protected boolean	emitBitmap	Whether the primary bitmap is emitted on pack; overridable via XML.
protected ISOValidator[]	fvlds	FieldValidator array.
protected int	maxValidField	Highest valid field number; copied from ISOBasePackager and overridable via XML.
protected ISOBaseValidator[]	mvlds	MsgValidator array

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
GenericValidatingPackager()	Default constructor.
GenericValidatingPackager(InputStream stream)	Constructs a packager loading its field/validator descriptions from an XML stream.
GenericValidatingPackager(String fileName)	Constructs a packager loading its field/validator descriptions from an XML file.

Method Summary

Modifier and Type	Method	Description
void	readFile(String filename)	It define GenericValidatorContentHandler like handler.
void	setFieldValidator(ISOFieldValidator[] fvlds)	Replaces the field-level validator array.
void	setGenericPackagerParams(Attributes atts)	Applies packager configuration from the SAX attributes of the packager XML element.
void	setMsgValidator(ISOBaseValidator[] msgVlds)	Replaces the message-level validator array.
ISOComponent	validate(ISOComponent m)	Runs all configured field- and message-level validators against m.

Methods inherited from class GenericPackager

emitBitMap, getBitMapfieldPackager, getDescription, getFirstField, getMaxValidField, 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	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, pack, setFieldPackager, setFieldPackager, setHeaderLength, setThirdBitmapField, unpack, 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.
byte[]	pack(ISOComponent m)	pack method that works in conjunction with ISOBasePackager.unpack(ISOComponent, byte[]).
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.
int	unpack(ISOComponent m, byte[] b)	Unpacks an ISO-8583 byte array into the given message container.
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

Field Details

maxValidField

protected int maxValidField

Highest valid field number; copied from ISOBasePackager and overridable via XML.

emitBitmap

protected boolean emitBitmap

Whether the primary bitmap is emitted on pack; overridable via XML.

bitmapField

protected int bitmapField

Field number that carries the primary bitmap; overridable via XML.

fvlds

protected ISOValidator[] fvlds

FieldValidator array.

mvlds

protected ISOBaseValidator[] mvlds

MsgValidator array

Constructor Details

GenericValidatingPackager

public GenericValidatingPackager()
                          throws ISOException

Default constructor.

Throws:

ISOException - if the underlying packager cannot be initialized

GenericValidatingPackager

public GenericValidatingPackager(String fileName)
                          throws ISOException

Constructs a packager loading its field/validator descriptions from an XML file.

Parameters:

fileName - XML descriptor file

Throws:

ISOException - if the file cannot be parsed

GenericValidatingPackager

public GenericValidatingPackager(InputStream stream)
                          throws ISOException

Constructs a packager loading its field/validator descriptions from an XML stream.

Parameters:

stream - XML descriptor input stream

Throws:

ISOException - if the stream cannot be parsed

Method Details

readFile

public void readFile(String filename)
              throws ISOException

It define GenericValidatorContentHandler like handler.

Overrides:

readFile in class GenericPackager

Parameters:

filename - The XML field description file

Throws:

ISOException - if the file cannot be read or parsed

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

setMsgValidator

public void setMsgValidator(ISOBaseValidator[] msgVlds)

Replaces the message-level validator array.

Parameters:

msgVlds - new message-level validators

setFieldValidator

public void setFieldValidator(ISOFieldValidator[] fvlds)

Replaces the field-level validator array.

Parameters:

fvlds - new field-level validators

validate

public ISOComponent validate(ISOComponent m)
                      throws ISOException

Runs all configured field- and message-level validators against m.

Specified by:

validate in interface ISOValidator

Parameters:

m - component (typically an ISOMsg) to validate

Returns:

the validated component, possibly with error fields attached

Throws:

ISOException - if validation fails and a validator throws