com.prowidesoftware.swift.model

Class MxSwiftMessage

java.lang.Object

com.prowidesoftware.swift.model.AbstractSwiftMessage

com.prowidesoftware.swift.model.MxSwiftMessage

All Implemented Interfaces:

Serializable

public class MxSwiftMessage
extends AbstractSwiftMessage

Container of raw representation of an MX (ISO 20022) SWIFT message, intended for message persistence. The class holds the full xml content plus message identification metadata gathered from the application header.
Notice, the scope of Prowide MX model is the message payload (the actual message or body data) which is the fundamental purpose of the transmission. The transmission wrappers (overhead data) are excluded and intentionally ignored if found.

MMX messages are uniquely identify by their business process, message functionality, variant and version.
Consider the following example: TREA.001.001.02

• TREA refers to 'Treasury'
• 001 refers to 'NDF opening (notification)'
• 001 refers to the variant
• 02 refers to the version message format, in this case version 2 of 'NDF opening' type.

businessProcess: Alphabetic code in four positions (fixed length) identifying the Business Process

functionality: Alphanumeric code in three positions (fixed length) identifying the Message Functionality

variant: Numeric code in three positions (fixed length) identifying a particular flavor (variant) of Message Functionality

version: Numeric code in two positions (fixed length) identifying the version.

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
MxSwiftMessage()
MxSwiftMessage(File file) Creates a new message reading the message the content from a file.
MxSwiftMessage(InputStream stream) Creates a new message reading the message the content from an input stream.
MxSwiftMessage(String xml) Creates a new message reading the message the content from a string.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyTo(MxSwiftMessage msg) copies attributes from this object to the given object non inherited copied attributes: functionality variant version
boolean	equals(Object obj)
ApplicationHeader	getApplicationHeader()
MxBusinessProcess	getBusinessProcess()
String	getFunctionality()
String	getVariant()
String	getVersion()
int	hashCode()
static MxSwiftMessage	parse(File file) Creates a new message reading the message the content from a file.
static MxSwiftMessage	parse(InputStream stream) Creates a new message reading the message the content from an input stream.
static MxSwiftMessage	parse(String xml) Creates a new message reading the message the content from a string.
MxSwiftMessage	readFile(File file) Deprecated. use the constructor {@link #MxSwiftMessage(File) instead
void	setApplicationHeader(ApplicationHeader applicationHeader)
void	setBusinessProcess(MxBusinessProcess businessProcess)
protected void	setDataFromNamespace(String namespace)
void	setFunctionality(String functionality)
void	setVariant(String variant)
void	setVersion(String version)
protected void	updateFromMessage() This method updates the object attributes with metadata parsed from the message, identifier, sender, receiver, direction and specific data for MT/MX. If the raw content contains multiple messages, only the first one will be read for metadata an message identification.

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

addNote, addStatus, contains, contains, copyTo, findStatusInfo, getChecksum, getCreationDate, getDirection, getFilename, getId, getIdentifier, getLastData, getLastData, getLastModified, getMessage, getMessageName, getNotes, getPaddedId, getPreviousStatusInfo, getProperties, getProperty, getProperty, getPropertyBoolean, getPropertyBoolean, getReceiver, getSender, getStatus, getStatusInfo, getStatusTrail, isIncoming, isInput, isOutgoing, isOutput, isStatus, isStatus, isStatus, isStatus, message, sanityCheckProperties, setChecksum, setCreationDate, setDirection, setFilename, setId, setIdentifier, setLastModified, setMessage, setNotes, setProperties, setProperty, setProperty, setReceiver, setSender, setStatus, setStatus, setStatusTrail

Methods inherited from class java.lang.Object

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

Constructor Detail

MxSwiftMessage

public MxSwiftMessage()

MxSwiftMessage

public MxSwiftMessage(String xml)

Creates a new message reading the message the content from a string. Performs a fast parsing of the header 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.

See Also:

AbstractSwiftMessage#AbstractSwiftMessage(String)}

MxSwiftMessage

public MxSwiftMessage(InputStream stream)
               throws IOException

Creates a new message reading the message the content from an input stream.

Throws:

IOException

Since:

7.7

See Also:

#MxSwiftMessage(String)}, AbstractSwiftMessage#AbstractSwiftMessage(InputStream)}

MxSwiftMessage

public MxSwiftMessage(File file)
               throws IOException

Creates a new message reading the message the content from a file.

Throws:

IOException

Since:

7.7

See Also:

#MxSwiftMessage(String)}, AbstractSwiftMessage#AbstractSwiftMessage(File)}

Method Detail

parse

public static MxSwiftMessage parse(String xml)

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

Since:

7.7

parse

public static MxSwiftMessage 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 MxSwiftMessage(InputStream)

Throws:

IOException

Since:

7.7

parse

public static MxSwiftMessage 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 MxSwiftMessage(File)

Throws:

IOException

Since:

7.7

updateFromMessage

protected void updateFromMessage()

Description copied from class: AbstractSwiftMessage

This method updates the object attributes with metadata parsed from the message, identifier, sender, receiver, direction and specific data for MT/MX.
If the raw content contains multiple messages, only the first one will be read for metadata an message identification. If the message content is invalid the metadata will be left blank.

Specified by:

updateFromMessage in class AbstractSwiftMessage

Since:

7.7

See Also:

AbstractSwiftMessage.updateFromMessage()

getBusinessProcess

public MxBusinessProcess getBusinessProcess()

setBusinessProcess

public void setBusinessProcess(MxBusinessProcess businessProcess)

getFunctionality

public String getFunctionality()

setFunctionality

public void setFunctionality(String functionality)

getVariant

public String getVariant()

setVariant

public void setVariant(String variant)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSwiftMessage

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSwiftMessage

readFile

public MxSwiftMessage readFile(File file)
                        throws IOException

Deprecated. use the constructor {@link #MxSwiftMessage(File) instead

Specified by:

readFile in class AbstractSwiftMessage

Throws:

IOException

setDataFromNamespace

protected void setDataFromNamespace(String namespace)

getApplicationHeader

public ApplicationHeader getApplicationHeader()

setApplicationHeader

public void setApplicationHeader(ApplicationHeader applicationHeader)

copyTo

public void copyTo(MxSwiftMessage msg)

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

• functionality
• variant
• version

Parameters:

msg -

Since:

7.7

See Also:

AbstractSwiftMessage.copyTo(AbstractSwiftMessage)