Class ISOBaseValidatingPackager

java.lang.Object

org.jpos.iso.ISOBasePackager

org.jpos.iso.packager.ISOBaseValidatingPackager

All Implemented Interfaces:

ISOPackager, ISOValidator, LogSource

Direct Known Subclasses:

CTCSubElementPackager, CTCSubFieldPackager

public class ISOBaseValidatingPackager
extends ISOBasePackager
implements ISOValidator

Base Packager class envolving validators. It implements ISOValidator interface and define an implementation for validate method. Validation is for composed components.

Title: jPOS

Description: Java Framework for Financial Systems

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

Company: www.jPOS.org

Field Summary

Fields

Modifier and Type	Field	Description
protected ISOValidator[]	fldVld	field validator array.
protected ISOBaseValidator[]	msgVld	Message level validators

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

Method Summary

Modifier and Type	Method	Description
void	setFieldValidator(ISOValidator[] fvlds)	Sets the array of field validators.
void	setMsgValidator(ISOBaseValidator[] msgVlds)	Sets the array of message-level validators.
ISOComponent	validate(ISOComponent m)	Validates an ISOComponent.

Methods inherited from class ISOBasePackager

createISOMsg, emitBitMap, fieldUnpackLogger, getBitMapfieldPackager, getDescription, getFieldDescription, getFieldPackager, getFirstField, getHeaderLength, getLogger, getMaxValidField, getRealm, getThirdBitmapField, pack, setFieldPackager, setFieldPackager, setHeaderLength, setLogger, setThirdBitmapField, unpack, unpack

Modifier and Type	Method	Description
ISOMsg	createISOMsg()	Factory hook returning the ISOMsg subclass produced during unpack.
protected boolean	emitBitMap()	Indicates whether a primary bitmap is emitted on pack.
protected static void	fieldUnpackLogger(LogEvent evt, int fldno, ISOComponent c, ISOFieldPackager fld, boolean logFieldName)	Internal helper logging function.
protected ISOFieldPackager	getBitMapfieldPackager()	Returns the field packager used for the primary bitmap.
String	getDescription()	Returns a human-readable description of this packager.
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.
protected int	getFirstField()	usually 2 for normal fields, 1 for bitmap-less or ANSI X9.2
int	getHeaderLength()	Returns the configured ISO header length in bytes.
Logger	getLogger()	Returns the Logger associated with this source.
protected int	getMaxValidField()	Returns the highest valid field number for this packager.
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	setLogger(Logger logger, String realm)	Attaches a Logger and realm to this log source.
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

msgVld

protected ISOBaseValidator[] msgVld

Message level validators

fldVld

protected ISOValidator[] fldVld

field validator array.

Constructor Details

ISOBaseValidatingPackager

public ISOBaseValidatingPackager()

Default constructor.

Method Details

validate

public ISOComponent validate(ISOComponent m)
                      throws ISOException

Description copied from interface: ISOValidator

Validates an ISOComponent.

Specified by:

validate in interface ISOValidator

Parameters:

m - the ISO component to validate

Returns:

the validated (possibly modified) component

Throws:

ISOException - if break-on-error is assumed and there are some errors

setFieldValidator

public void setFieldValidator(ISOValidator[] fvlds)

Sets the array of field validators.

Parameters:

fvlds - the field validator array

setMsgValidator

public void setMsgValidator(ISOBaseValidator[] msgVlds)

Sets the array of message-level validators.

Parameters:

msgVlds - the message validator array