com.prowidesoftware.swift.model.mt

Class AbstractMT

java.lang.Object

com.prowidesoftware.swift.model.AbstractMessage

com.prowidesoftware.swift.model.mt.AbstractMT

Direct Known Subclasses:

MT012, MT019, MT101, MT101_RUR6, MT102, MT102_STP, MT103, MT103_REMIT, MT103_RUR6, MT103_STP, MT104, MT105, MT107, MT110, MT111, MT112, MT190, MT191, MT192, MT195, MT196, MT198, MT199, MT200, MT201, MT202, MT202_RUR6, MT202COV, MT203, MT204, MT205, MT205COV, MT207, MT210, MT256, MT290, MT291, MT292, MT295, MT296, MT298, MT299, MT300, MT303, MT304, MT305, MT306, MT307, MT320, MT321, MT330, MT340, MT341, MT350, MT360, MT361, MT362, MT364, MT365, MT370, MT380, MT381, MT390, MT391, MT392, MT395, MT396, MT398, MT399, MT400, MT410, MT412, MT416, MT420, MT422, MT430, MT450, MT455, MT456, MT490, MT491, MT492, MT495, MT496, MT498, MT499, MT500, MT501, MT502, MT503, MT504, MT505, MT506, MT507, MT508, MT509, MT510, MT513, MT514, MT515, MT516, MT517, MT518, MT519, MT524, MT526, MT527, MT530, MT535, MT536, MT537, MT538, MT540, MT541, MT542, MT543, MT544, MT545, MT546, MT547, MT548, MT549, MT558, MT559, MT564, MT565, MT566, MT567, MT568, MT569, MT574_IRSLST, MT574_W8BENO, MT575, MT576, MT577, MT578, MT579, MT581, MT586, MT590, MT591, MT592, MT595, MT596, MT598, MT599, MT600, MT601, MT604, MT605, MT606, MT607, MT608, MT609, MT620, MT643, MT644, MT646, MT649, MT670, MT671, MT690, MT691, MT692, MT695, MT696, MT698, MT699, MT700, MT701, MT705, MT707, MT710, MT711, MT720, MT721, MT730, MT732, MT734, MT740, MT742, MT747, MT750, MT752, MT754, MT756, MT760, MT767, MT768, MT769, MT790, MT791, MT792, MT795, MT796, MT798, MT798_743, MT798_745, MT798_760, MT798_761, MT798_762, MT798_763, MT798_764, MT798_766, MT798_767, MT798_769, MT798_779, MT798_788, MT798_789, MT798_790, MT798_791, MT798_793, MT798_794, MT798_799, MT799, MT800, MT801, MT802, MT824, MT890, MT891, MT892, MT895, MT896, MT898, MT899, MT900, MT900_RUR6, MT910, MT910_RUR6, MT920, MT935, MT940, MT940_RUR6, MT941, MT942, MT942_RUR6, MT950, MT950_RUR6, MT970, MT971, MT972, MT973, MT985, MT986, MT990, MT991, MT992, MT995, MT996, MT998, MT999, SystemMessage

public abstract class AbstractMT
extends AbstractMessage

Base class for specific MTs.
This class implements several high level delegate methods of SwiftMessage.

Since:

6.0

Author:

www.prowidesoftware.com

Field Summary

Fields

Modifier and Type	Field and Description
protected SwiftMessage	m

Constructor Summary

Constructors

Constructor and Description
AbstractMT() Creates a particular MT initialized with a new SwiftMessage.
AbstractMT(int messageType) Create an input message for the given type setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
AbstractMT(int messageType, String sender, String receiver) Creates a new input message for the given type setting the given sender and receiver. All mandatory header attributes are completed with default values.
AbstractMT(MtSwiftMessage m) Deprecated. use constructor from subclasses instead
AbstractMT(SwiftMessage m)

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(Field f) Adds the given field to the body block.
AbstractMT	append(Field... fields) Add all the fields to the end of the block4
AbstractMT	append(SwiftTagListBlock block) Add all tags from block to the end of the block4
AbstractMT	append(Tag... tags) Add all tags to the end of the block4
boolean	containsSequence(String name) Test if the MT class contains a getSequenceX method
boolean	containsSequenceList(String name) Test if the MT class contains a getSequenceXList method
static AbstractMT	create(int messageType) Create a blank message for the given category setting TEST bics as sender and receiver
static AbstractMT	create(int messageType, String sender, String receiver) Create a blank message for the given category setting the given sender and receiver BICs
String	FIN() Deprecated. use message() instead of this
String	getApplicationId()
String	getLogicalTerminal()
String	getMessagePriority()
abstract String	getMessageType() Returns this message type according to the specific class.
MtId	getMtId() Returns the MT message identification. Composed by the business process, message type and variant.
String	getReceiver() Gets the message receiver BIC from the message headers.
String	getSender() Gets the message sender BIC from the message headers.
SwiftTagListBlock	getSequence(String name) Convenience method to get a sequence named name from this message without creating the MTXXX class.
SwiftTagListBlock	getSequence(String name, SwiftTagListBlock block) Get the sequence with the given name from the tags in block invoking the proper static method in the mt class
static SwiftTagListBlock	getSequence(SwiftMessage msg, String sequence) Deprecated. use msg.toMT().getSequence(sequence) instead of this method
List<SwiftTagListBlock>	getSequenceList(String name) Convenience method to get the list of sequences named name from this message without creating the MTXXX class.
List<SwiftTagListBlock>	getSequenceList(String name, SwiftTagListBlock block) Get the sequence with a given name from the given subblock
String	getSequenceNumber()
String	getServiceId()
String	getSessionNumber()
SwiftMessage	getSwiftMessage()
protected SwiftMessage	getSwiftMessageNotNullOrException() Get the swift message guaranteeing a non null return.
MTVariant	getVariant()
boolean	isIncoming()
boolean	isInput()
boolean	isOutgoing()
boolean	isOutput()
boolean	isType(Integer type)
String	json() Returns the JSON representation of the SwiftMessage attribute
String	message() Get this message as string containing the FIN message (SWIFT MT message).
String	nameFromClass()
static AbstractMT	parse(File file) Parses a the file content into the MTxxx that corresponds to the found message type.
static AbstractMT	parse(InputStream stream) Parses a the stream content into the MTxxx that corresponds to the found message type.
static AbstractMT	parse(String fin) Parses a the string content into the MTxxx that corresponds to the found message type.
protected static SwiftMessage	read(String fin) Base implementation for subclasses static parse.
void	setReceiver(BIC bic) Sets the logical terminal field of the application header block 2. Notice this method only makes sense when building input messages (messages that are going to be sent to swift).
void	setReceiver(String receiver) Sets the logical terminal field of the application header block 2.
void	setSender(BIC bic) Sets the logical terminal field of the header block 1 with the parameter BIC code and default LT identifier (the message is assumed to be of type input). Notice this method only makes sense when building input messages (messages that are going to be sent to swift).
void	setSender(String sender) Sets the logical terminal field of the header block 1 (the message is assumed to be of type input).
void	setSwiftMessage(SwiftMessage m)
String	toString()
void	write(File file) Writes the message into a file with its message content in the FIN format.
void	write(OutputStream stream) Writes the message into a given output stream with its message content in the FIN format, encoding content in UTF-8.
String	xml() Returns the message content in XML format. The XML created is the internal format defined and used by Prowide Core. Notice: it is neither a standard nor the MX version of this MT.

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

getMessageStandardType, isMT, isMX

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m

protected SwiftMessage m

Constructor Detail

AbstractMT

public AbstractMT(SwiftMessage m)

Parameters:

m - swift message to model as a particular MT

AbstractMT

public AbstractMT(MtSwiftMessage m)

Deprecated. use constructor from subclasses instead

Parameters:

m - swift message to model as a particular MT

AbstractMT

public AbstractMT()

Creates a particular MT initialized with a new SwiftMessage. All blocks are initialized.

AbstractMT

public AbstractMT(int messageType)

Create an input message for the given type setting TEST BICS as sender and receiver.
All mandatory header attributes are completed with default values.

Parameters:

messageType -

Since:

7.6

See Also:

AbstractMT(int, String, String)

AbstractMT

public AbstractMT(int messageType,
          String sender,
          String receiver)

Creates a new input message for the given type setting the given sender and receiver.
All mandatory header attributes are completed with default values. In particular the sender and receiver addresses will be filled with proper default LT identifier and branch codes if not provided,

Parameters:

messageType - message type to create

sender - the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters

receiver - the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters

Since:

7.6

Method Detail

parse

public static AbstractMT parse(String fin)
                        throws IOException

Parses a the string content into the MTxxx that corresponds to the found message type. If the file contains more than a message it will parse the first one. If the string is empty, does not contain any MT message, the message type is not set or an error occurs reading and parsing the message content; this method returns null.

Parameters:

fin - string a string containing a swift MT message

Returns:

parser message or null if string content could not be parsed

Throws:

IOException

Since:

7.7

parse

public static AbstractMT parse(InputStream stream)
                        throws IOException

Parses a the stream content into the MTxxx that corresponds to the found message type.

Parameters:

stream - a stream containing a swift MT message

Returns:

parser message or null if stream content could not be parsed

Throws:

IOException

Since:

7.7

See Also:

parse(String)

parse

public static AbstractMT parse(File file)
                        throws IOException

Parses a the file content into the MTxxx that corresponds to the found message type.

Parameters:

file - a file containing a swift MT message

Returns:

parser message or null if file content could not be parsed

Throws:

IOException

Since:

7.7

See Also:

parse(String)

getSwiftMessage

public SwiftMessage getSwiftMessage()

Returns:

the swift message object modeled as this particular MT

getSwiftMessageNotNullOrException

protected SwiftMessage getSwiftMessageNotNullOrException()

Get the swift message guaranteeing a non null return. If the message is null an illegal state exception is thrown

Returns:

the swift message set

Since:

7.7

setSwiftMessage

public void setSwiftMessage(SwiftMessage m)

Parameters:

m - swift message to model as a particular MT

getApplicationId

public String getApplicationId()

Returns:

application id from block 1

See Also:

SwiftBlock1.getApplicationId()

getServiceId

public String getServiceId()

Returns:

service id from block 1

See Also:

SwiftBlock1.getServiceId()

getLogicalTerminal

public String getLogicalTerminal()

Returns:

logical terminal from block 1

See Also:

SwiftBlock1.getLogicalTerminal()

getSessionNumber

public String getSessionNumber()

Returns:

session number from block 1

See Also:

SwiftBlock1.getSessionNumber()

getSequenceNumber

public String getSequenceNumber()

Returns:

sequence number from block 1

See Also:

SwiftBlock1.getSequenceNumber()

getMessagePriority

public String getMessagePriority()

Returns:

message priority from block 2

See Also:

SwiftBlock2.getMessagePriority()

isInput

public boolean isInput()

Returns:

true if message is an input message sent to SWIFTNet, false otherwise

See Also:

SwiftMessage.isOutgoing()

isOutgoing

public boolean isOutgoing()

Returns:

true if the message is outgoing (sent to SWIFT), false other case; using the direction attribute.

Since:

7.8.4

See Also:

SwiftMessage.isOutgoing()

isOutput

public boolean isOutput()

Returns:

true if message is an output message received from SWIFTNet, false otherwise

See Also:

SwiftMessage.isIncoming()

isIncoming

public boolean isIncoming()

Returns:

true if the message is incoming (received from SWIFT), false other case; using the direction attribute.

Since:

7.8.4

See Also:

SwiftMessage.isIncoming()

setSender

public void setSender(String sender)

Sets the logical terminal field of the header block 1 (the message is assumed to be of type input). The sender addresses will be filled with proper default LT identifier and branch codes if not provided.
Notice this method only makes sense when building input messages (messages that are going to be sent to swift). To emulate a received message from swift, the sender information must be put at block 2.

Parameters:

sender - the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters

Since:

6.4

See Also:

SwiftBlock1.setSender(String)

setSender

public void setSender(BIC bic)

Sets the logical terminal field of the header block 1 with the parameter BIC code and default LT identifier (the message is assumed to be of type input).
Notice this method only makes sense when building input messages (messages that are going to be sent to swift). To emulate a received message from swift, the sender information must be put at block 2.

Parameters:

bic - a BIC code

Since:

6.4

See Also:

SwiftBlock1.setLogicalTerminal(BIC)

getSender

public String getSender()

Gets the message sender BIC from the message headers. For outgoing messages this is the the logical terminal at block 1, and for incoming messages this is logical terminal at the MIR of block 2.

Returns:

the found address or null if the message or the header block are null.

Since:

6.4

setReceiver

public void setReceiver(String receiver)

Sets the logical terminal field of the application header block 2. The receiver addresses will be filled with proper default LT identifier and branch codes if not provided.
Notice this method only makes sense when building input messages (messages that are going to be sent to swift). To emulate a received message from swift, a call to this method has no effect, and the receiver information must be manually set in block 1.

Parameters:

receiver - the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters

Since:

6.4

See Also:

SwiftBlock2Input.setReceiver(String)

setReceiver

public void setReceiver(BIC bic)

Sets the logical terminal field of the application header block 2.
Notice this method only makes sense when building input messages (messages that are going to be sent to swift). To emulate a received message from swift, a call to this method has no effect, and the receiver information must be manually set in block 1.

Parameters:

bic - a BIC code

Since:

6.4

See Also:

SwiftBlock2Input.setReceiver(String)

getReceiver

public String getReceiver()

Gets the message receiver BIC from the message headers. For outgoing messages this is the receiver address at block 2, and for incoming messages this is logical terminal at block 1.

Returns:

the found BIC code of the sender or null if the message or the header block are null.

Since:

6.4

addField

public void addField(Field f)

Adds the given field to the body block.

Parameters:

f -

FIN

@Deprecated
public String FIN()

Deprecated. use message() instead of this

Gets a String containing the FIN message (SWIFT MT message). Note: This method has been replaced by message() So the same method can be used for both MT and MX This method may be deleted in 2016

Returns:

a string with the FIN format representation of the message

See Also:

message()

message

public String message()

Get this message as string containing the FIN message (SWIFT MT message).

Returns:

a string with the FIN format representation of the message

Since:

7.7

getMessageType

public abstract String getMessageType()

Returns this message type according to the specific class.

Returns:

the message type number of this MT

Since:

6.4

getSequenceList

public List<SwiftTagListBlock> getSequenceList(String name)

Convenience method to get the list of sequences named name from this message without creating the MTXXX class. getSequenceList("A") is the same as ((CastToSpecificMT)getMT()).getSequenceAList() The requested sequence must be repetitive for non repetitive sequences use getSequence(name)

Parameters:

name -

Returns:

found sequences or empty list

Since:

7.6

See Also:

getSequence(String)

getSequenceList

public List<SwiftTagListBlock> getSequenceList(String name,
                                      SwiftTagListBlock block)

Get the sequence with a given name from the given subblock

Parameters:

name - the name of the sequence to get. Must not be null

block - the block from where to get the sequence This method invokes the static version of getSequenceList(String)

Returns:

found sequences or empty list

Since:

7.8.1

See Also:

getSequenceList(String)

containsSequenceList

public boolean containsSequenceList(String name)

Test if the MT class contains a getSequenceXList method

Since:

7.8

See Also:

getSequenceList(String)

containsSequence

public boolean containsSequence(String name)

Test if the MT class contains a getSequenceX method

Since:

7.8

See Also:

getSequence(String)

getSequence

public SwiftTagListBlock getSequence(String name)

Convenience method to get a sequence named name from this message without creating the MTXXX class. getSequence("A") is the same as ((CastToSpecificMT)getMT()).getSequenceA() The requested sequence must NOT be repetitive for repetitive sequences use getSequenceList(name)

Parameters:

name -

Returns:

found sequence or empty sequence block

Since:

7.6

See Also:

getSequenceList(String)

getSequence

public SwiftTagListBlock getSequence(String name,
                            SwiftTagListBlock block)

Get the sequence with the given name from the tags in block invoking the proper static method in the mt class

Parameters:

name - the name of the sequence to get

block - the block where to extract the sequence from

Returns:

found sequence or empty sequence block

Since:

7.8.1

toString

public String toString()

Overrides:

toString in class Object

create

public static AbstractMT create(int messageType)

Create a blank message for the given category setting TEST bics as sender and receiver

Parameters:

messageType -

Returns:

created message object

Since:

7.6

See Also:

create(int, String, String)

create

public static AbstractMT create(int messageType,
                String sender,
                String receiver)

Create a blank message for the given category setting the given sender and receiver BICs

Parameters:

messageType -

sender -

receiver -

Returns:

created message object

Since:

7.6

append

public AbstractMT append(SwiftTagListBlock block)

Add all tags from block to the end of the block4

Parameters:

block -

Returns:

this same object for chained calls

Since:

7.6

append

public AbstractMT append(Tag... tags)

Add all tags to the end of the block4

Parameters:

tags -

Returns:

this same object for chained calls

Since:

7.6

append

public AbstractMT append(Field... fields)

Add all the fields to the end of the block4

Parameters:

fields -

Returns:

this same object for chained calls

Since:

7.6

read

protected static SwiftMessage read(String fin)

Base implementation for subclasses static parse.

Since:

7.7

write

public void write(File file)
           throws IOException

Writes the message into a file with its message content in the FIN format.

Parameters:

file - a non null file to write, if it does not exists, it will be created

Throws:

IOException

Since:

7.7

write

public void write(OutputStream stream)
           throws IOException

Writes the message into a given output stream with its message content in the FIN format, encoding content in UTF-8.

Parameters:

stream - a non null stream to write

Throws:

IOException

Since:

7.7

json

public String json()

Returns the JSON representation of the SwiftMessage attribute

Since:

7.7

See Also:

SwiftMessage.toJson()

xml

public String xml()

Returns the message content in XML format.
The XML created is the internal format defined and used by Prowide Core.
Notice: it is neither a standard nor the MX version of this MT.

Since:

7.7

isType

public boolean isType(Integer type)

getSequence

public static SwiftTagListBlock getSequence(SwiftMessage msg,
                            String sequence)

Deprecated. use msg.toMT().getSequence(sequence) instead of this method

Get the given sequence from the msg

Parameters:

msg - the message to extract the sequence from

sequence - the sequence name

Returns:

the given sequence or null if msg is null, sequence is null or the message can not be converted to MT

Since:

7.7

See Also:

SwiftMessage.toMT()

getVariant

public MTVariant getVariant()

Returns:

the corresponding MT variant or null if flag field is not present

Since:

7.8

nameFromClass

public String nameFromClass()

getMtId

public MtId getMtId()

Returns the MT message identification.
Composed by the business process, message type and variant. Example: fin.103.STP

Returns:

the constructed message id

Since:

7.8.4