com.prowidesoftware.swift.model

Class MtSwiftMessage

java.lang.Object

com.prowidesoftware.swift.model.AbstractSwiftMessage

com.prowidesoftware.swift.model.MtSwiftMessage

All Implemented Interfaces:

Serializable

public class MtSwiftMessage
extends AbstractSwiftMessage

Container of raw representations of an MT (ISO 15022) SWIFT message, intended for message persistence. The class holds the full FIN message content plus minimal message identification metadata.

Since:

7.0

Author:

www.prowidesoftware.com

See Also:

Serialized Form

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.AbstractSwiftMessage

identifier, PROPERTY_NAME, receiver, sender

Constructor Summary

Constructors

Constructor and Description
MtSwiftMessage()
MtSwiftMessage(File file) Creates a new message reading the message the content from a file.
MtSwiftMessage(InputStream stream) Creates a new message reading the message the content from an input stream.
MtSwiftMessage(String fin) Creates a new message reading the message the content from a string.
MtSwiftMessage(SwiftMessage model) Creates an MtSwiftMessage from a SwiftMessage.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyTo(MtSwiftMessage msg) copies attributes from this object to the given object non inherited copied attributes: mir modelMessage mur pde pdm uuid
boolean	equals(Object obj)
String	getMessageName() Get the value of the property under the AbstractSwiftMessage.PROPERTY_NAME key or the result of getMessageType()
String	getMessageType() Get the message type. For MTs this is the MT type number present in the identifier attribute.
Integer	getMessageTypeInt() Get the integer value of the getMessageType() or null if the identifier attribute is not set or not a number
String	getMir()
SwiftMessage	getModelMessage() Deprecated. the internal model message is no longer user to avoid inconsistencies between the raw format and the parsed data.
String	getMur()
String	getPde()
String	getPdm()
String	getUuid()
int	hashCode()
boolean	isType(int type) Test if this message is a given specific type.
boolean	isType(Integer... type) Tell if this message is any of the given types.
static MtSwiftMessage	parse(File file) Creates a new message reading the message the content from a file.
static MtSwiftMessage	parse(InputStream stream) Creates a new message reading the message the content from an input stream.
static MtSwiftMessage	parse(String fin) Creates a new message reading the message the content from a string.
MtSwiftMessage	readFile(File file) Deprecated. use the constructor MtSwiftMessage(File) instead
void	setMir(String mir)
void	setModelMessage(SwiftMessage modelMessage) Deprecated. the internal model message is no longer user to avoid inconsistencies between the raw format and the parsed data. use updateFromModel()
void	setMur(String mur)
void	setPde(String pde)
void	setPdm(String pdm)
void	setUuid(String uuid)
String	toString()
void	updateFromFIN() Updates the derived attributes from the current raw (FIN) message attribute.
void	updateFromFIN(String fin) Updates the the attributes with the raw message and its metadata from the given raw (FIN) message content.
protected void	updateFromMessage() Updates the object attributes with metadata parsed from the message raw content: identifier, sender, receiver, direction and specific data for the implementing subclass.
void	updateFromModel() Deprecated. use update from string or constructor from String, File or InputStream instead, the internal model message is no longer user to avoid inconsistencies between the raw format and the parsed data.
void	updateFromModel(AbstractMT mt) The AbstractMT is serialized to its FIN raw format to set the internal raw message attribute.
void	updateFromModel(SwiftMessage model) The SwiftMessage is serialized to its FIN raw format to set the internal raw message attribute.

Methods inherited from class com.prowidesoftware.swift.model.AbstractSwiftMessage

addNote, addRevision, addStatus, contains, contains, copyTo, createRevision, findStatusInfo, getChecksum, getCreationDate, getDirection, getFileFormat, getFilename, getId, getIdentifier, getLastData, getLastData, getLastModified, getMessage, getNotes, getPaddedId, getPreviousStatusInfo, getProperties, getProperty, getProperty, getPropertyBoolean, getPropertyBoolean, getReceiver, getReference, getRevisions, getSender, getStatus, getStatusInfo, getStatusTrail, isIncoming, isInput, isMT, isMX, isOutgoing, isOutput, isStatus, isStatus, isStatus, isStatus, match, message, messageStandardType, sanityCheckProperties, setChecksum, setCreationDate, setDirection, setFileFormat, setFilename, setId, setIdentifier, setLastModified, setMessage, setNotes, setProperties, setProperty, setProperty, setReceiver, setReference, setRevisions, setSender, setStatus, setStatus, setStatusTrail

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MtSwiftMessage

public MtSwiftMessage()

MtSwiftMessage

public MtSwiftMessage(String fin)

Creates a new message reading the message the content from a string. Performs a fast parsing of the header and trailer blocks to identify the message and gather metadata information for the object attributes.
If the string contains several messages, the whole passed content will be save in the message attribute but identification and metadata will be parser from the first one found only. Notice that if an ACK/NAK followed by the original message is passed, this object will represent the ACK/NAK.
File format is set to FileFormat.FIN

See Also:

AbstractSwiftMessage.AbstractSwiftMessage(String)

MtSwiftMessage

public MtSwiftMessage(InputStream stream)
               throws IOException

Creates a new message reading the message the content from an input stream.
File format is set to FileFormat.FIN

Throws:

IOException

Since:

7.7

See Also:

MtSwiftMessage(String), AbstractSwiftMessage.AbstractSwiftMessage(InputStream)

MtSwiftMessage

public MtSwiftMessage(File file)
               throws IOException

Creates a new message reading the message the content from a file.
File format is set to FileFormat.FIN

Throws:

IOException

Since:

7.7

See Also:

MtSwiftMessage(String), AbstractSwiftMessage.AbstractSwiftMessage(File)

MtSwiftMessage

public MtSwiftMessage(SwiftMessage model)

Creates an MtSwiftMessage from a SwiftMessage.

See Also:

updateFromModel()

Method Detail

parse

public static MtSwiftMessage parse(String fin)

Creates a new message reading the message the content from a string. This is a static version of the constructor MtSwiftMessage(String)

Since:

7.7

parse

public static MtSwiftMessage parse(InputStream stream)
                            throws IOException

Creates a new message reading the message the content from an input stream. This is a static version of the constructor MtSwiftMessage(InputStream)

Throws:

IOException

Since:

7.7

parse

public static MtSwiftMessage parse(File file)
                            throws IOException

Creates a new message reading the message the content from a file. This is a static version of the constructor MtSwiftMessage(File)

Throws:

IOException

Since:

7.7

updateFromMessage

protected void updateFromMessage()
                          throws IllegalArgumentException

Description copied from class: AbstractSwiftMessage

Updates the object attributes with metadata parsed from the message raw content: identifier, sender, receiver, direction and specific data for the implementing subclass.

Specified by:

updateFromMessage in class AbstractSwiftMessage

Throws:

IllegalArgumentException - if the source format is not FileFormat.FIN or if the message cannot be parsed into a MtSwiftMessage object

Since:

7.7

See Also:

AbstractSwiftMessage.updateFromMessage()

updateFromFIN

public void updateFromFIN(String fin)

Updates the the attributes with the raw message and its metadata from the given raw (FIN) message content.

Parameters:

fin - the new message content

See Also:

updateFromMessage()

updateFromFIN

public void updateFromFIN()

Updates the derived attributes from the current raw (FIN) message attribute. This is similar to create a new message instance from string content.

updateFromModel

public void updateFromModel(SwiftMessage model)

The SwiftMessage is serialized to its FIN raw format to set the internal raw message attribute. And the header attributes are set with data from the parameter SwiftMessage. Notice that the SwiftMessage is not stored as internal attribute.

updateFromModel

public void updateFromModel(AbstractMT mt)

The AbstractMT is serialized to its FIN raw format to set the internal raw message attribute. And the header attributes are set with data from the parameter AbstractMT. Notice that the AbstractMT is not stored as internal attribute.

Since:

7.8.4

updateFromModel

@Deprecated
public void updateFromModel()

Deprecated. use update from string or constructor from String, File or InputStream instead, the internal model message is no longer user to avoid inconsistencies between the raw format and the parsed data.

getModelMessage

@Deprecated
public SwiftMessage getModelMessage()

Deprecated. the internal model message is no longer user to avoid inconsistencies between the raw format and the parsed data.

setModelMessage

@Deprecated
public void setModelMessage(SwiftMessage modelMessage)

Deprecated. the internal model message is no longer user to avoid inconsistencies between the raw format and the parsed data. use updateFromModel()

getMessageType

public String getMessageType()

Get the message type.
For MTs this is the MT type number present in the identifier attribute. For example for fin.103.STP returns 103 For MX returns the same as #getIdentifier()

getMessageTypeInt

public Integer getMessageTypeInt()

Get the integer value of the getMessageType() or null if the identifier attribute is not set or not a number

getMessageName

public String getMessageName()

Get the value of the property under the AbstractSwiftMessage.PROPERTY_NAME key or the result of getMessageType()

Overrides:

getMessageName in class AbstractSwiftMessage

Returns:

the set message name or message type

isType

public boolean isType(Integer... type)

Tell if this message is any of the given types.

Parameters:

type - a variable list of integers for testing to match as the current message type

Returns:

true if the current message type is any of the integers given as parameters, and false in any other case

isType

public boolean isType(int type)

Test if this message is a given specific type.

Parameters:

type - the message type given as int, to test

Returns:

true if this message type is the type given, or false in any other case

toString

public String toString()

Overrides:

toString in class Object

getPde

public String getPde()

setPde

public void setPde(String pde)

getPdm

public String getPdm()

setPdm

public void setPdm(String pdm)

getMir

public String getMir()

setMir

public void setMir(String mir)

getMur

public String getMur()

setMur

public void setMur(String mur)

getUuid

public String getUuid()

setUuid

public void setUuid(String uuid)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSwiftMessage

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSwiftMessage

readFile

@Deprecated
public MtSwiftMessage readFile(File file)
                        throws IOException

Deprecated. use the constructor MtSwiftMessage(File) instead

Specified by:

readFile in class AbstractSwiftMessage

Throws:

IOException

copyTo

public void copyTo(MtSwiftMessage msg)

copies attributes from this object to the given object non inherited copied attributes:

• mir
• modelMessage
• mur
• pde
• pdm
• uuid

Parameters:

msg -

Since:

7.7

See Also:

AbstractSwiftMessage.copyTo(AbstractSwiftMessage)