com.prowidesoftware.swift.model

Class MtSwiftMessage

java.lang.Object

com.prowidesoftware.swift.model.AbstractSwiftMessage

com.prowidesoftware.swift.model.MtSwiftMessage

All Implemented Interfaces:

java.io.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

See Also:

Serialized Form

Field Summary

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

identifier, IDENTIFIER_ACK, IDENTIFIER_NAK, PROPERTY_NAME, receiver, sender

Constructor Summary

Constructors

Constructor and Description
MtSwiftMessage()
MtSwiftMessage(java.io.File file) Creates a new message reading the message the content from a file.
MtSwiftMessage(java.io.InputStream stream) Creates a new message reading the message the content from an input stream.
MtSwiftMessage(java.lang.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

Modifier and Type	Method and Description
void	copyTo(MtSwiftMessage msg) Creates a full copy of the current message object into another message.
boolean	equals(java.lang.Object obj)
java.lang.String	getMessageName() Get the value of the property under the AbstractSwiftMessage.PROPERTY_NAME key or the result of getMessageType()
java.lang.String	getMessageType() Get the message type. For MTs this is the MT type number present in the identifier attribute.
java.lang.Integer	getMessageTypeInt() Get the integer value of the getMessageType() or null if the identifier attribute is not set or not a number
java.lang.String	getMir() Gets the MIR (Message Input Reference)
SwiftMessage	getModelMessage() Deprecated. The internal model message is no longer kept as class attribute to avoid inconsistencies between the raw format and the parsed data. To parse the internal raw format into a model object use modelMessage() instead of this getter.
java.lang.String	getMur() Gets the MUR (Message User Reference) from block 3
java.lang.String	getPde() Gets PDE (Possible Duplicate Emission) flag from the trailer block or null if the trailer or the PDE field is not present
java.lang.String	getPdm() Gets PDM from the trailer block or null if the trailer or the PDM field is not present
java.lang.String	getUuid() Gets a UUID (User Unique Identifier)
int	hashCode()
boolean	isType(int type) Test if this message is a given specific type.
boolean	isType(java.lang.Integer... type) Tell if this message is any of the given types.
SwiftMessage	modelMessage() Parses the raw message content into a SwiftMessage object.
static MtSwiftMessage	parse(java.io.File file) Creates a new message reading the message the content from a file.
static MtSwiftMessage	parse(java.io.InputStream stream) Creates a new message reading the message the content from an input stream.
static MtSwiftMessage	parse(java.lang.String fin) Creates a new message reading the message the content from a string.
MtSwiftMessage	readFile(java.io.File file) Deprecated. use the constructor MtSwiftMessage(File) instead
void	setMir(java.lang.String mir) Sets the MIR attribute.
void	setModelMessage(SwiftMessage modelMessage) Deprecated. The internal model message is no longer kept as class attribute to avoid inconsistencies between the raw format and the parsed data. To update the internal raw format from a model object use updateFromModel(SwiftMessage) instead of this setter.
void	setMur(java.lang.String mur) Sets the MUR attribute.
void	setPde(java.lang.String pde) Sets the PDE attribute.
void	setPdm(java.lang.String pdm) Sets the PDM attribute.
void	setUuid(java.lang.String uuid) Sets a UUID This field is automatically updated on message update from FIN or model
java.lang.String	toString()
void	updateFromFIN() Updates the derived attributes from the current raw (FIN) message attribute.
void	updateFromFIN(java.lang.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 updateFromModel(SwiftMessage) or constructor MtSwiftMessage(SwiftMessage) instead, The internal model message is no longer kept as class attribute 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, bic11, contains, contains, copyTo, createRevision, findStatusInfo, findStatusInfo, findStatusInfoLast, findStatusInfoLast, formattedAmount, formattedAmount, getAmount, getChecksum, getChecksumBody, getCorrespondentBIC, getCreationDate, getCreationDayOfMonth, getCreationMonth, getCreationYear, getCurrency, getDirection, getFileFormat, getFilename, getId, getIdentifier, getLastData, getLastData, getLastModified, getMessage, getNotes, getPaddedId, getPreviousStatusInfo, getProperties, getProperty, getProperty, getPropertyBoolean, getPropertyBoolean, getReceiver, getReference, getRevisions, getSender, getStatus, getStatusInfo, getStatusTrail, identifiedAsACK, identifiedAsNAK, isIncoming, isInput, isMT, isMX, isOutgoing, isOutput, isStatus, isStatus, isStatus, isStatus, match, message, messageStandardType, sanityCheckProperties, setAmount, setChecksum, setChecksumBody, setCreationDate, setCurrency, 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(java.lang.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(java.io.InputStream stream)
               throws java.io.IOException

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

Throws:

java.io.IOException

Since:

7.7

See Also:

MtSwiftMessage(String), AbstractSwiftMessage.AbstractSwiftMessage(InputStream)

MtSwiftMessage

public MtSwiftMessage(java.io.File file)
               throws java.io.IOException

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

Throws:

java.io.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(java.lang.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(java.io.InputStream stream)
                            throws java.io.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:

java.io.IOException

Since:

7.7

parse

public static MtSwiftMessage parse(java.io.File file)
                            throws java.io.IOException

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

Throws:

java.io.IOException

Since:

7.7

updateFromMessage

protected void updateFromMessage()
                          throws java.lang.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:

java.lang.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(java.lang.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
 @ProwideDeprecated(phase4=_2018)
public void updateFromModel()

Deprecated. Use updateFromModel(SwiftMessage) or constructor MtSwiftMessage(SwiftMessage) instead, The internal model message is no longer kept as class attribute to avoid inconsistencies between the raw format and the parsed data.

getModelMessage

@Deprecated
 @ProwideDeprecated(phase3=_2018)
public SwiftMessage getModelMessage()

Deprecated. The internal model message is no longer kept as class attribute to avoid inconsistencies between the raw format and the parsed data. To parse the internal raw format into a model object use modelMessage() instead of this getter.

modelMessage

public SwiftMessage modelMessage()

Parses the raw message content into a SwiftMessage object.

Returns:

the parsed message or null if the raw content is not set or cannot be parsed

Since:

7.8.9

setModelMessage

@Deprecated
 @ProwideDeprecated(phase3=_2018)
public void setModelMessage(SwiftMessage modelMessage)

Deprecated. The internal model message is no longer kept as class attribute to avoid inconsistencies between the raw format and the parsed data. To update the internal raw format from a model object use updateFromModel(SwiftMessage) instead of this setter.

getMessageType

public java.lang.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 java.lang.Integer getMessageTypeInt()

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

getMessageName

public java.lang.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(java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPde

public java.lang.String getPde()

Gets PDE (Possible Duplicate Emission) flag from the trailer block or null if the trailer or the PDE field is not present

Returns:

the PDE flag or null

setPde

public void setPde(java.lang.String pde)

Sets the PDE attribute. This field is automatically updated on message update from FIN or model

Parameters:

pde - the PDE flag to set

See Also:

updateFromFIN(String), updateFromModel(AbstractMT), updateFromModel(SwiftMessage)

getPdm

public java.lang.String getPdm()

Gets PDM from the trailer block or null if the trailer or the PDM field is not present

Returns:

PDM flag or null

setPdm

public void setPdm(java.lang.String pdm)

Sets the PDM attribute. This field is automatically updated on message update from FIN or model

Parameters:

pde - the PDM flag to set

See Also:

updateFromFIN(String), updateFromModel(AbstractMT), updateFromModel(SwiftMessage)

getMir

public java.lang.String getMir()

Gets the MIR (Message Input Reference)

See Also:

SwiftMessage.getMIR()

setMir

public void setMir(java.lang.String mir)

Sets the MIR attribute. This field is automatically updated on message update from FIN or model

Parameters:

mir - the MIR to set

See Also:

updateFromFIN(String), updateFromModel(AbstractMT), updateFromModel(SwiftMessage)

getMur

public java.lang.String getMur()

Gets the MUR (Message User Reference) from block 3

Returns:

the MUR or null if not present in the message

See Also:

SwiftMessage.getMUR()

setMur

public void setMur(java.lang.String mur)

Sets the MUR attribute. This field is automatically updated on message update from FIN or model

Parameters:

mur - the MUR to set

See Also:

updateFromFIN(String), updateFromModel(AbstractMT), updateFromModel(SwiftMessage)

getUuid

public java.lang.String getUuid()

Gets a UUID (User Unique Identifier)

See Also:

SwiftMessage.getUUID()

setUuid

public void setUuid(java.lang.String uuid)

Sets a UUID This field is automatically updated on message update from FIN or model

Parameters:

uuid -

See Also:

updateFromFIN(String), updateFromModel(AbstractMT), updateFromModel(SwiftMessage)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSwiftMessage

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractSwiftMessage

readFile

@Deprecated
 @ProwideDeprecated(phase4=_2018)
public MtSwiftMessage readFile(java.io.File file)
                                                                      throws java.io.IOException

Deprecated. use the constructor MtSwiftMessage(File) instead

Specified by:

readFile in class AbstractSwiftMessage

Throws:

java.io.IOException

copyTo

public void copyTo(MtSwiftMessage msg)

Creates a full copy of the current message object into another message.

Parameters:

msg - target message

Since:

7.7

See Also:

AbstractSwiftMessage.copyTo(AbstractSwiftMessage)