Class FSDISOMsg

java.lang.Object

org.jpos.iso.ISOComponent

org.jpos.iso.ISOMsg

org.jpos.iso.FSDISOMsg

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Loggeable

public class FSDISOMsg
extends ISOMsg
implements Cloneable

An ISOMsg backed by a FSDMsg for fixed-schema message processing.

See Also:

• Serialized Form

Field Summary

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
FSDISOMsg()	Default constructor.
FSDISOMsg(FSDMsg fsd)	Creates an FSDISOMsg wrapping the given FSDMsg.

Method Summary

Modifier and Type	Method	Description
Object	clone()
Object	clone(int[] fields)	Partially clone an ISOMsg
void	dump(PrintStream p, String indent)	dump the message to a PrintStream.
FSDMsg	getFSDMsg()	Returns the underlying FSDMsg instance.
String	getMTI()	Returns the message type indicator.
String	getString(int fldno)	Return the String value associated with the given ISOField number
String	getString(String fld)	Return the String value associated with the given field path
boolean	hasField(int fldno)	Check if a given field is present
boolean	hasField(String fld)	Check if a field indicated by a fpath is present
void	merge(ISOMsg m)	Merges the content of the specified ISOMsg into this ISOMsg instance, excluding the header.
byte[]	pack()	Packs this message using the configured packager.
void	readExternal(ObjectInput in)
void	set(String name, String value)	Creates an ISOField associated with fldno within this ISOMsg.
void	setResponseMTI()	sets an appropriate response MTI.
int	unpack(byte[] b)	Unpacks the raw byte array into this message.
void	unpack(InputStream in)	Unpacks this component by reading from in.
void	writeExternal(ObjectOutput out)

Methods inherited from class ISOMsg

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

Modifier and Type	Method	Description
ISOMsg	clone(String... fpaths)	Partially clone an ISOMsg by field paths
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.
ISOPackager	getPackager()	Returns the packager associated with this message.
ISOSource	getSource()	Returns the associated ISOSource (e.g.
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	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, boolean mergeHeader)	Merges the content of the specified ISOMsg into this ISOMsg instance.
void	move(int oldFieldNumber, int newFieldNumber)	moves a field (renumber)
protected void	readDirection(ObjectInput in)	Deserializes the message direction from the given ObjectInput.
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, 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	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()
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.
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.

Constructor Details

FSDISOMsg

public FSDISOMsg()

Default constructor.

FSDISOMsg

public FSDISOMsg(FSDMsg fsd)

Creates an FSDISOMsg wrapping the given FSDMsg.

Parameters:

fsd - the FSDMsg to wrap

Method Details

getMTI

public String getMTI()

Description copied from class: ISOMsg

Returns the message type indicator.

Overrides:

getMTI in class ISOMsg

Returns:

current MTI

pack

public byte[] pack()
            throws ISOException

Description copied from class: ISOMsg

Packs this message using the configured packager.

Overrides:

pack in class ISOMsg

Returns:

the packed message

Throws:

ISOException - on packing error

unpack

public int unpack(byte[] b)
           throws ISOException

Description copied from class: ISOMsg

Unpacks the raw byte array into this message.

Overrides:

unpack in class ISOMsg

Parameters:

b - - raw message

Returns:

consumed bytes

Throws:

ISOException - on unpacking error

unpack

public void unpack(InputStream in)
            throws IOException,
ISOException

Description copied from class: ISOMsg

Unpacks this component by reading from in.

Overrides:

unpack in class ISOMsg

Parameters:

in - source stream

Throws:

IOException - on I/O failure

ISOException - on unpacking error

getFSDMsg

public FSDMsg getFSDMsg()

Returns the underlying FSDMsg instance.

Returns:

the underlying FSDMsg

getString

public String getString(int fldno)

Description copied from class: ISOMsg

Return the String value associated with the given ISOField number

Overrides:

getString in class ISOMsg

Parameters:

fldno - the Field Number

Returns:

field's String value

getString

public String getString(String fld)

Description copied from class: ISOMsg

Return the String value associated with the given field path

Overrides:

getString in class ISOMsg

Parameters:

fld - field path

Returns:

field's String value (may be null)

hasField

public boolean hasField(int fldno)

Description copied from class: ISOMsg

Check if a given field is present

Overrides:

hasField in class ISOMsg

Parameters:

fldno - the Field Number

Returns:

boolean indicating the existence of the field

hasField

public boolean hasField(String fld)

Description copied from class: ISOMsg

Check if a field indicated by a fpath is present

Overrides:

hasField in class ISOMsg

Parameters:

fld - dot-separated field path (i.e. 63.2)

Returns:

true if field present

dump

public void dump(PrintStream p,
 String indent)

Description copied from class: ISOMsg

dump the message to a PrintStream. The output is sorta XML, intended to be easily parsed.
Each component is responsible for its own dump function, ISOMsg just calls dump on every valid field.

Specified by:

dump in interface Loggeable

Overrides:

dump in class ISOMsg

Parameters:

p - - print stream

indent - - optional indent string

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class ISOMsg

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class ISOMsg

Throws:

IOException

ClassNotFoundException

clone

public Object clone()

Overrides:

clone in class ISOMsg

clone

public Object clone(int[] fields)

Description copied from class: ISOMsg

Partially clone an ISOMsg

Overrides:

clone in class ISOMsg

Parameters:

fields - int array of fields to go

Returns:

new ISOMsg instance

merge

public void merge(ISOMsg m)

Description copied from class: ISOMsg

Merges the content of the specified ISOMsg into this ISOMsg instance, excluding the header. This method is a convenience wrapper around ISOMsg.merge(ISOMsg, boolean) with the mergeHeader parameter set to false for backward compatibility, indicating that the header of the input message will not be merged.

Overrides:

merge in class ISOMsg

Parameters:

m - the ISOMsg to merge into this message

setResponseMTI

public void setResponseMTI()

Description copied from class: ISOMsg

sets an appropriate response MTI. i.e. 0100 becomes 0110
i.e. 0201 becomes 0210
i.e. 1201 becomes 1210

Overrides:

setResponseMTI in class ISOMsg

set

public void set(String name,
 String value)

Description copied from class: ISOMsg

Creates an ISOField associated with fldno within this ISOMsg.

Overrides:

set in class ISOMsg

Parameters:

name - dot-separated field path (i.e. 63.2)

value - field value