Class ISOVMsg

java.lang.Object

org.jpos.iso.ISOComponent

org.jpos.iso.ISOMsg

org.jpos.iso.ISOVMsg

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, ISOVErrorList, Loggeable

public class ISOVMsg
extends ISOMsg
implements ISOVErrorList

Wrapper class resulting from process of validating an ISOMsg instance. Contains details of the original msg and validation-error details too. Normally in validation process when an error is detected by validator in msg, then the msg is replaced by an instance of this class, containning error details.

Title: jPOS

Description: Java Framework for Financial Systems

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

Company: www.jPOS.org

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected LinkedList	errors	list of errors

Fields inherited from class ISOMsg

direction, dirty, fieldNumber, fields, header, INCOMING, maxField, maxFieldDirty, OUTGOING, packager, trailer

Modifier and Type	Field	Description
protected int	direction	Message direction: INCOMING or OUTGOING.
protected boolean	dirty	Dirty flags for tracking state changes.
protected int	fieldNumber	Field number of this message when nested inside another ISOMsg.
protected Map<Integer,Object>	fields	Map of field number to field value.
protected ISOHeader	header	Optional ISO header for this message.
static final int	INCOMING	Constant indicating an incoming message direction.
protected int	maxField	Highest field number currently set in this message.
protected boolean	maxFieldDirty	Dirty flags for tracking state changes.
static final int	OUTGOING	Constant indicating an outgoing message direction.
protected ISOPackager	packager	The packager used to pack/unpack this message.
protected byte[]	trailer	Optional trailer bytes appended to the packed message.

Constructor Summary

Constructors

Constructor	Description
ISOVMsg(ISOMsg Source)	Create a message from original instance adding error data.
ISOVMsg(ISOMsg Source, ISOVError FirstError)	Wraps the source message and attaches an initial validation error.

Method Summary

Modifier and Type	Method	Description
boolean	addISOVError(ISOVError Error)	Add an error component to the list of errors.
ListIterator	errorListIterator()	Get an error iterator instance.

Methods inherited from class ISOMsg

clone, clone, clone, dump, getBytes, getBytes, getChildren, getComponent, getComponent, getComposite, getDirection, getFieldNumber, getHeader, getISOHeader, getKey, getMaxField, getMTI, getPackager, getSource, getString, getString, getTrailer, getValue, getValue, getValue, hasAny, hasAny, hasField, hasField, hasFields, hasFields, hasMTI, isAdministrative, isAuthorization, isChargeback, isFeeCollection, isFileAction, isFinancial, isIncoming, isInner, isNetworkManagement, isOutgoing, isReconciliation, isRequest, isResponse, isRetransmission, isReversal, merge, merge, move, pack, readDirection, readExternal, readHeader, readPackager, recalcBitMap, set, set, set, set, set, set, setDirection, setFieldNumber, setHeader, setHeader, setMTI, setPackager, setResponseMTI, setRetransmissionMTI, setSource, setTrailer, setValue, toString, unpack, unpack, unset, unset, unset, unset, with, with, with, with, with, without, without, writeDirection, writeExternal, writeHeader, writePackager

Modifier and Type	Method	Description
Object	clone()
Object	clone(int... fields)	Partially clone an ISOMsg
ISOMsg	clone(String... fpaths)	Partially clone an ISOMsg by field paths
void	dump(PrintStream p, String indent)	dump the message to a PrintStream.
byte[]	getBytes(int fldno)	Return the byte[] value associated with the given ISOField number
byte[]	getBytes(String fpath)	Return the String value associated with the given field path
Map	getChildren()	clone fields
ISOComponent	getComponent(int fldno)	get the component associated with the given field number
ISOComponent	getComponent(String fpath)	get the component associated with the given field number
ISOComponent	getComposite()	In order to interchange Composites and Leafs we use getComposite().
int	getDirection()	Returns the message direction.
int	getFieldNumber()	Returns the field number this component occupies within its container.
byte[]	getHeader()	get optional message header image
ISOHeader	getISOHeader()	Return this messages ISOHeader
Object	getKey()	valid on Leafs only.
int	getMaxField()	Returns the highest field number present in this message.
String	getMTI()	Returns the message type indicator.
ISOPackager	getPackager()	Returns the packager associated with this message.
ISOSource	getSource()	Returns the associated ISOSource (e.g.
String	getString(int fldno)	Return the String value associated with the given ISOField number
String	getString(String fpath)	Return the String value associated with the given field path
byte[]	getTrailer()	Get optional trailer image.
Object	getValue()	Returns this message itself as its value.
Object	getValue(int fldno)	Return the object value associated with the given field number
Object	getValue(String fpath)	Return the object value associated with the given field path
boolean	hasAny(int[] fields)	Check if the message has any of these fields
boolean	hasAny(String... fields)	Check if the message has any of these fields
boolean	hasField(int fldno)	Check if a given field is present
boolean	hasField(String fpath)	Check if a field indicated by a fpath is present
boolean	hasFields()	Returns true if this message has at least one field set.
boolean	hasFields(int[] fields)	Check if all fields are present
boolean	hasMTI()	Returns true if this message has an MTI field (field 0) set.
boolean	isAdministrative()	Returns true if this is an administrative message (MTI second digit = 6).
boolean	isAuthorization()	Returns true if this is an authorization message (MTI second digit = 1).
boolean	isChargeback()	Returns true if this is a chargeback message (MTI second digit = 4, last digit 2 or 3).
boolean	isFeeCollection()	Returns true if this is a fee collection message (MTI second digit = 7).
boolean	isFileAction()	Returns true if this is a file action message (MTI second digit = 3).
boolean	isFinancial()	Returns true if this is a financial message (MTI second digit = 2).
boolean	isIncoming()	Returns true if this message was received from a channel.
boolean	isInner()	Returns true if this is an inner (sub-) message.
boolean	isNetworkManagement()	Returns true if this is a network management message (MTI second digit = 8).
boolean	isOutgoing()	Returns true if this message is to be sent via a channel.
boolean	isReconciliation()	Returns true if this is a reconciliation message (MTI second digit = 5).
boolean	isRequest()	Returns true if the MTI suggests this is a request message.
boolean	isResponse()	Returns true if the MTI suggests this is a response message.
boolean	isRetransmission()	Returns true if this is a retransmission (MTI last digit = 1).
boolean	isReversal()	Returns true if this is a reversal message (MTI second digit = 4, last digit 0 or 1).
void	merge(ISOMsg m)	Merges the content of the specified ISOMsg into this ISOMsg instance, excluding the header.
void	merge(ISOMsg m, boolean mergeHeader)	Merges the content of the specified ISOMsg into this ISOMsg instance.
void	move(int oldFieldNumber, int newFieldNumber)	moves a field (renumber)
byte[]	pack()	Packs this message using the configured packager.
protected void	readDirection(ObjectInput in)	Deserializes the message direction from the given ObjectInput.
void	readExternal(ObjectInput in)
protected void	readHeader(ObjectInput in)	Deserializes the message header from the given ObjectInput.
protected void	readPackager(ObjectInput in)	Deserializes the packager from the given ObjectInput.
void	recalcBitMap()	setup BitMap
void	set(int fldno, byte[] value)	Creates an ISOBinaryField associated with fldno within this ISOMsg.
void	set(int fldno, String value)	Creates an ISOField associated with fldno within this ISOMsg.
void	set(String fpath, byte[] value)	Creates an ISOField associated with fldno within this ISOMsg.
void	set(String fpath, String value)	Creates an ISOField associated with fldno within this ISOMsg.
void	set(String fpath, ISOComponent c)	Creates an ISOField associated with fldno within this ISOMsg
void	set(ISOComponent c)	Set a field within this message
void	setDirection(int direction)	Sets the direction information related to this message
void	setFieldNumber(int fieldNumber)	changes this Component field number Use with care, this method does not change any reference held by a Composite.
void	setHeader(byte[] b)	Sets an optional message header image
void	setHeader(ISOHeader header)	Sets the ISO header for this message.
void	setMTI(String mti)	Sets the message type indicator.
void	setPackager(ISOPackager p)	Sets the packager used to pack/unpack this message.
void	setResponseMTI()	sets an appropriate response MTI.
void	setRetransmissionMTI()	sets an appropriate retransmission MTI
void	setSource(ISOSource source)	Let this ISOMsg object hold a weak reference to an ISOSource (usually used to carry a reference to the incoming ISOChannel)
void	setTrailer(byte[] trailer)	Sets optional trailer data.
void	setValue(Object obj)	Don't call setValue on an ISOMsg.
String	toString()
int	unpack(byte[] b)	Unpacks the raw byte array into this message.
void	unpack(InputStream in)	Unpacks this component by reading from in.
void	unset(int fldno)	Unset a field if it exists, otherwise ignore.
void	unset(int... flds)	Unsets several fields at once
void	unset(String fpath)	Unset a field referenced by a fpath if it exists, otherwise ignore.
void	unset(String... fpaths)	Unset a a set of fields referenced by fpaths if any ot them exist, otherwise ignore.
ISOMsg	with(int fldno, byte[] value)	Sets a top-level binary field and returns this message for fluent chaining.
ISOMsg	with(int fldno, String value)	Sets a top-level character field and returns this message for fluent chaining.
ISOMsg	with(String fpath, byte[] value)	Sets a binary field by path and returns this message for fluent chaining.
ISOMsg	with(String fpath, String value)	Sets a character field by path and returns this message for fluent chaining.
ISOMsg	with(String fpath, ISOComponent c)	Sets a component by path and returns this message for fluent chaining.
ISOMsg	without(int... flds)	Unsets one or more top-level fields and returns this message for fluent chaining.
ISOMsg	without(String... fpaths)	Unsets one or more field paths, including nested composites and dataset elements, and returns this message for fluent chaining.
protected void	writeDirection(ObjectOutput out)	Serializes the message direction to the given ObjectOutput.
void	writeExternal(ObjectOutput out)
protected void	writeHeader(ObjectOutput out)	Serializes the message header to the given ObjectOutput.
protected void	writePackager(ObjectOutput out)	Serializes the packager class name to the given ObjectOutput.

Methods inherited from class ISOComponent

getBytes, pack

Modifier and Type	Method	Description
byte[]	getBytes()	get Value as bytes (when possible)
void	pack(OutputStream out)	Packs this component and writes it to out.

Methods inherited from class Object

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

Methods inherited from interface Loggeable

dump

Modifier and Type	Method	Description
default void	dump(PrintStream p, String indent, LogRenderer.Type type)	Dumps a representation of this object using the specified renderer type.

Field Details

errors

protected LinkedList errors

list of errors

Constructor Details

ISOVMsg

public ISOVMsg(ISOMsg Source)

Create a message from original instance adding error data.

Parameters:

Source - Original msg instance.

ISOVMsg

public ISOVMsg(ISOMsg Source,
 ISOVError FirstError)

Wraps the source message and attaches an initial validation error.

Parameters:

Source - original ISOMsg to wrap

FirstError - initial error attached to the message

Method Details

addISOVError

public boolean addISOVError(ISOVError Error)

Add an error component to the list of errors.

Specified by:

addISOVError in interface ISOVErrorList

Parameters:

Error - Error instance to add.

Returns:

True if the list of errors change after operation.

See Also:

• ISOVError

errorListIterator

public ListIterator errorListIterator()

Get an error iterator instance.

Specified by:

errorListIterator in interface ISOVErrorList

Returns:

iterator.