Class ISOMsgRef.Ref

java.lang.Object

org.jpos.iso.ISOComponent

org.jpos.iso.ISOMsg

org.jpos.tlv.ISOMsgRef.Ref

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, OffsetIndexedComposite, Loggeable

Enclosing class:

ISOMsgRef

public class ISOMsgRef.Ref
extends ISOMsg
implements OffsetIndexedComposite

Inner class providing offset-indexed access to a referenced ISO message.

See Also:

• Serialized Form

Field Summary

Fields inherited from class ISOMsg

direction, dirty, 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 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.

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.
byte[]	getBytes()	get Value as bytes (when possible)
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.
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.
int	getOffset()	Returns the current offset.
ISOPackager	getPackager()	Returns the packager associated with this message.
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
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	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
void	incOffset()	Increments the current offset by one.
boolean	isIncoming()	Returns true if this message was received from a channel.
boolean	isInner()	Returns true if this is an inner (sub-) message.
boolean	isOutgoing()	Returns true if this message is to be sent via a channel.
boolean	isRequest()	Returns true if the MTI suggests this is a request message.
void	merge(ISOMsg m)	Merges the content of the specified ISOMsg into this ISOMsg instance, excluding the header.
void	move(int oldFieldNumber, int newFieldNumber)	moves a field (renumber)
byte[]	pack()	Packs this message using the configured packager.
void	pack(OutputStream out)	Packs this component and writes it to out.
void	recalcBitMap()	setup BitMap
void	resetOffset()	Resets the offset to its initial value.
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	setOffset(int offset)	Sets the current offset.
void	setPackager(ISOPackager p)	Sets the packager used to pack/unpack this message.
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.

Methods inherited from class ISOMsg

clone, getFieldNumber, getSource, getTrailer, hasAny, hasAny, hasMTI, isAdministrative, isAuthorization, isChargeback, isFeeCollection, isFileAction, isFinancial, isNetworkManagement, isReconciliation, isResponse, isRetransmission, isReversal, merge, readDirection, readExternal, readHeader, readPackager, setResponseMTI, setRetransmissionMTI, setSource, setTrailer, unset, with, with, with, with, with, without, without, writeDirection, writeExternal, writeHeader, writePackager

Modifier and Type	Method	Description
ISOMsg	clone(String... fpaths)	Partially clone an ISOMsg by field paths
int	getFieldNumber()	Returns the field number this component occupies within its container.
ISOSource	getSource()	Returns the associated ISOSource (e.g.
byte[]	getTrailer()	Get optional trailer image.
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	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	isNetworkManagement()	Returns true if this is a network management message (MTI second digit = 8).
boolean	isReconciliation()	Returns true if this is a reconciliation message (MTI second digit = 5).
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.
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	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	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 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.

Method Details

incOffset

public void incOffset()

Description copied from interface: OffsetIndexedComposite

Increments the current offset by one.

Specified by:

incOffset in interface OffsetIndexedComposite

setOffset

public void setOffset(int offset)

Description copied from interface: OffsetIndexedComposite

Sets the current offset.

Specified by:

setOffset in interface OffsetIndexedComposite

Parameters:

offset - the new offset value

resetOffset

public void resetOffset()

Description copied from interface: OffsetIndexedComposite

Resets the offset to its initial value.

Specified by:

resetOffset in interface OffsetIndexedComposite

getOffset

public int getOffset()

Description copied from interface: OffsetIndexedComposite

Returns the current offset.

Specified by:

getOffset in interface OffsetIndexedComposite

Returns:

the current offset

getKey

public Object getKey()
              throws ISOException

Description copied from class: ISOComponent

valid on Leafs only. The value returned is used by ISOMsg as a key to this field.

Overrides:

getKey in class ISOMsg

Returns:

object representing the field number

Throws:

ISOException - thrown by composites; leaves return their key

setFieldNumber

public void setFieldNumber(int fieldNumber)

Description copied from class: ISOMsg

changes this Component field number
Use with care, this method does not change any reference held by a Composite.

Overrides:

setFieldNumber in class ISOMsg

Parameters:

fieldNumber - new field number

setValue

public void setValue(Object obj)
              throws ISOException

Description copied from class: ISOMsg

Don't call setValue on an ISOMsg. You'll sure get an ISOException. It's intended to be used on Leafs

Overrides:

setValue in class ISOMsg

Parameters:

obj - value to set (not supported on ISOMsg)

Throws:

ISOException - always

See Also:

• ISOField
• ISOException

set

public void set(ISOComponent c)
         throws ISOException

Description copied from class: ISOMsg

Set a field within this message

Overrides:

set in class ISOMsg

Parameters:

c - - a component

Throws:

ISOException - always thrown by leaves; composites override this

unset

public void unset(int fldno)

Description copied from class: ISOMsg

Unset a field if it exists, otherwise ignore.

Overrides:

unset in class ISOMsg

Parameters:

fldno - - the field number

getComposite

public ISOComponent getComposite()

Description copied from class: ISOMsg

In order to interchange Composites and Leafs we use getComposite(). A Composite component returns itself and a Leaf returns null.

Overrides:

getComposite in class ISOMsg

Returns:

ISOComponent

getValue

public Object getValue()

Description copied from class: ISOMsg

Returns this message itself as its value.

Overrides:

getValue in class ISOMsg

Returns:

this ISOMsg

getBytes

public byte[] getBytes()
                throws ISOException

Description copied from class: ISOComponent

get Value as bytes (when possible)

Overrides:

getBytes in class ISOComponent

Returns:

byte[] representing this field

Throws:

ISOException - thrown by composites or when the value cannot be rendered as bytes

getMaxField

public int getMaxField()

Description copied from class: ISOMsg

Returns the highest field number present in this message.

Overrides:

getMaxField in class ISOMsg

Returns:

the max field number

getChildren

public Map getChildren()

Description copied from class: ISOMsg

clone fields

Overrides:

getChildren in class ISOMsg

Returns:

copy of fields

pack

public void pack(OutputStream out)
          throws IOException,
ISOException

Description copied from class: ISOComponent

Packs this component and writes it to out.

Overrides:

pack in class ISOComponent

Parameters:

out - destination stream

Throws:

IOException - if writing fails

ISOException - if packing fails

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

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

setDirection

public void setDirection(int direction)

Description copied from class: ISOMsg

Sets the direction information related to this message

Overrides:

setDirection in class ISOMsg

Parameters:

direction - can be either ISOMsg.INCOMING or ISOMsg.OUTGOING

setHeader

public void setHeader(byte[] b)

Description copied from class: ISOMsg

Sets an optional message header image

Overrides:

setHeader in class ISOMsg

Parameters:

b - header image

setHeader

public void setHeader(ISOHeader header)

Description copied from class: ISOMsg

Sets the ISO header for this message.

Overrides:

setHeader in class ISOMsg

Parameters:

header - the ISOHeader to set on this message

getHeader

public byte[] getHeader()

Description copied from class: ISOMsg

get optional message header image

Overrides:

getHeader in class ISOMsg

Returns:

message header image (may be null)

getISOHeader

public ISOHeader getISOHeader()

Description copied from class: ISOMsg

Return this messages ISOHeader

Overrides:

getISOHeader in class ISOMsg

Returns:

header associated with this ISOMsg, can be null

getDirection

public int getDirection()

Description copied from class: ISOMsg

Returns the message direction.

Overrides:

getDirection in class ISOMsg

Returns:

the direction (ISOMsg.INCOMING or ISOMsg.OUTGOING)

See Also:

• ISOChannel

isIncoming

public boolean isIncoming()

Description copied from class: ISOMsg

Returns true if this message was received from a channel.

Overrides:

isIncoming in class ISOMsg

Returns:

true if this is an incoming message

See Also:

• ISOChannel

isOutgoing

public boolean isOutgoing()

Description copied from class: ISOMsg

Returns true if this message is to be sent via a channel.

Overrides:

isOutgoing in class ISOMsg

Returns:

true if this is an outgoing message

See Also:

• ISOChannel

setPackager

public void setPackager(ISOPackager p)

Description copied from class: ISOMsg

Sets the packager used to pack/unpack this message.

Overrides:

setPackager in class ISOMsg

Parameters:

p - - a peer packager

getPackager

public ISOPackager getPackager()

Description copied from class: ISOMsg

Returns the packager associated with this message.

Overrides:

getPackager in class ISOMsg

Returns:

the peer packager

set

public void set(int fldno,
 String value)

Description copied from class: ISOMsg

Creates an ISOField associated with fldno within this ISOMsg.

Overrides:

set in class ISOMsg

Parameters:

fldno - field number

value - field value

set

public void set(String fpath,
 String value)

Description copied from class: ISOMsg

Creates an ISOField associated with fldno within this ISOMsg.

Overrides:

set in class ISOMsg

Parameters:

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

value - field value

set

public void set(String fpath,
 ISOComponent c)
         throws ISOException

Description copied from class: ISOMsg

Creates an ISOField associated with fldno within this ISOMsg

Overrides:

set in class ISOMsg

Parameters:

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

c - component

Throws:

ISOException - on error

set

public void set(String fpath,
 byte[] value)

Description copied from class: ISOMsg

Creates an ISOField associated with fldno within this ISOMsg.

Overrides:

set in class ISOMsg

Parameters:

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

value - binary field value

set

public void set(int fldno,
 byte[] value)

Description copied from class: ISOMsg

Creates an ISOBinaryField associated with fldno within this ISOMsg.

Overrides:

set in class ISOMsg

Parameters:

fldno - field number

value - field value

unset

public void unset(int[] flds)

Description copied from class: ISOMsg

Unsets several fields at once

Overrides:

unset in class ISOMsg

Parameters:

flds - - array of fields to be unset from this ISOMsg

unset

public void unset(String fpath)

Description copied from class: ISOMsg

Unset a field referenced by a fpath if it exists, otherwise ignore.

Overrides:

unset in class ISOMsg

Parameters:

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

recalcBitMap

public void recalcBitMap()
                  throws ISOException

Description copied from class: ISOMsg

setup BitMap

Overrides:

recalcBitMap in class ISOMsg

Throws:

ISOException - on error

getComponent

public ISOComponent getComponent(int fldno)

Description copied from class: ISOMsg

get the component associated with the given field number

Overrides:

getComponent in class ISOMsg

Parameters:

fldno - the Field Number

Returns:

the Component

getValue

public Object getValue(int fldno)

Description copied from class: ISOMsg

Return the object value associated with the given field number

Overrides:

getValue in class ISOMsg

Parameters:

fldno - the Field Number

Returns:

the field Object

getValue

public Object getValue(String fpath)
                throws ISOException

Description copied from class: ISOMsg

Return the object value associated with the given field path

Overrides:

getValue in class ISOMsg

Parameters:

fpath - field path

Returns:

the field Object (may be null)

Throws:

ISOException - on error

getComponent

public ISOComponent getComponent(String fpath)
                          throws ISOException

Description copied from class: ISOMsg

get the component associated with the given field number

Overrides:

getComponent in class ISOMsg

Parameters:

fpath - field path

Returns:

the Component

Throws:

ISOException - on error

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 fpath)

Description copied from class: ISOMsg

Return the String value associated with the given field path

Overrides:

getString in class ISOMsg

Parameters:

fpath - field path

Returns:

field's String value (may be null)

getBytes

public byte[] getBytes(int fldno)

Description copied from class: ISOMsg

Return the byte[] value associated with the given ISOField number

Overrides:

getBytes in class ISOMsg

Parameters:

fldno - the Field Number

Returns:

field's byte[] value or null if ISOException or UnsupportedEncodingException happens

getBytes

public byte[] getBytes(String fpath)

Description copied from class: ISOMsg

Return the String value associated with the given field path

Overrides:

getBytes in class ISOMsg

Parameters:

fpath - field path

Returns:

field's byte[] 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

hasFields

public boolean hasFields(int[] fields)

Description copied from class: ISOMsg

Check if all fields are present

Overrides:

hasFields in class ISOMsg

Parameters:

fields - an array of fields to check for presence

Returns:

true if all fields are present

hasField

public boolean hasField(String fpath)

Description copied from class: ISOMsg

Check if a field indicated by a fpath is present

Overrides:

hasField in class ISOMsg

Parameters:

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

Returns:

true if field present

hasFields

public boolean hasFields()

Description copied from class: ISOMsg

Returns true if this message has at least one field set.

Overrides:

hasFields in class ISOMsg

Returns:

true if at least one field is present

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

toString

public String toString()

Overrides:

toString in class ISOMsg

Returns:

a string suitable for a log

isInner

public boolean isInner()

Description copied from class: ISOMsg

Returns true if this is an inner (sub-) message.

Overrides:

isInner in class ISOMsg

Returns:

true on inner messages

setMTI

public void setMTI(String mti)
            throws ISOException

Description copied from class: ISOMsg

Sets the message type indicator.

Overrides:

setMTI in class ISOMsg

Parameters:

mti - new MTI

Throws:

ISOException - if message is inner message

move

public void move(int oldFieldNumber,
 int newFieldNumber)
          throws ISOException

Description copied from class: ISOMsg

moves a field (renumber)

Overrides:

move in class ISOMsg

Parameters:

oldFieldNumber - old field number

newFieldNumber - new field number

Throws:

ISOException - on error

getMTI

public String getMTI()
              throws ISOException

Description copied from class: ISOMsg

Returns the message type indicator.

Overrides:

getMTI in class ISOMsg

Returns:

current MTI

Throws:

ISOException - on inner message or MTI not set

isRequest

public boolean isRequest()
                  throws ISOException

Description copied from class: ISOMsg

Returns true if the MTI suggests this is a request message.

Overrides:

isRequest in class ISOMsg

Returns:

true if message "seems to be" a request

Throws:

ISOException - on MTI not set