java.lang.Object
- com.prowidesoftware.swift.model.AbstractMessage
- - com.prowidesoftware.swift.model.mt.AbstractMT
  - - com.prowidesoftware.swift.model.mt.mt0xx.MT009

All Implemented Interfaces:

JsonSerializable, java.io.Serializable
```
@Generated
public class MT009
extends AbstractMT
implements java.io.Serializable
```
MT 009 - System Request to Logout.
SWIFT MT009 (ISO 15022) message structure:
- Field 173 (M)
This source code is specific to release SRU 2024
For additional resources check https://www.prowidesoftware.com/resources
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`NAME`	Constant for MT name, this is part of the classname, after MT.
`static int`	`SRU`	Constant identifying the SRU to which this class belongs to.

Fields inherited from class com.prowidesoftware.swift.model.mt.AbstractMT
m

Constructor Summary

Constructors
Constructor	Description
`MT009()`	Creates and initializes a new MT009 input message setting TEST BICS as sender and receiver.
`MT009(MtSwiftMessage m)`	Creates an MT009 initialized with the parameter MtSwiftMessage.
`MT009(SwiftMessage m)`	Creates an MT009 initialized with the parameter SwiftMessage.
`MT009(java.io.File file)`	Creates a new MT009 by parsing a file with the message content in its swift FIN format.
`MT009(java.io.InputStream stream)`	Creates a new MT009 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`MT009(java.lang.String fin)`	Creates a new MT009 by parsing a String with the message content in its swift FIN format.
`MT009(java.lang.String sender, java.lang.String receiver)`	Creates and initializes a new MT009 input message from sender to receiver.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MT009`	`append(Field... fields)`	Add all the fields to the end of the block4.
`MT009`	`append(SwiftTagListBlock block)`	Add all tags from block to the end of the block4.
`MT009`	`append(Tag... tags)`	Add all tags to the end of the block4.
`static MT009`	`fromJson(java.lang.String json)`	Creates an MT009 messages from its JSON representation.
`Field173`	`getField173()`	Iterates through block4 fields and return the first one whose name matches 173, or null if none is found.
`java.lang.String`	`getMessageType()`	Returns this MT number.
`static MT009`	`parse(MtSwiftMessage m)`	Creates an MT009 initialized with the parameter MtSwiftMessage.
`static MT009`	`parse(java.io.File file)`	Creates a new MT009 by parsing a file with the message content in its swift FIN format.
`static MT009`	`parse(java.io.InputStream stream)`	Creates a new MT009 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
`static MT009`	`parse(java.lang.String fin)`	Creates a new MT009 by parsing a String with the message content in its swift FIN format.

Methods inherited from class com.prowidesoftware.swift.model.mt.AbstractMT
addField, containsSequence, containsSequenceList, create, create, getApplicationId, getFields, getLogicalTerminal, getMessagePriority, getMtId, getReceiver, getSender, getSequence, getSequence, getSequence, getSequenceList, getSequenceList, getSequenceNumber, getServiceId, getSessionNumber, getSignature, getSwiftMessage, getSwiftMessageNotNullOrException, getVariant, isIncoming, isInput, isOutgoing, isOutput, isType, message, nameFromClass, read, setReceiver, setReceiver, setSender, setSender, setSignature, setSwiftMessage, tag, tags, toJson, toString, write, write, xml

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
  - SRU
```
public static final int SRU
```
    Constant identifying the SRU to which this class belongs to.
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    Constant for MT name, this is part of the classname, after MT.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MT009
```
public MT009(SwiftMessage m)
```
    Creates an MT009 initialized with the parameter SwiftMessage.
    
    Parameters:
    
    m - swift message with the MT009 content
  - MT009
```
public MT009(MtSwiftMessage m)
```
    Creates an MT009 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT009 content, the parameter can not be null
    
    See Also:
    
    MT009(String)
  - MT009
```
public MT009()
```
    Creates and initializes a new MT009 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT009
```
public MT009(java.lang.String sender,
             java.lang.String receiver)
```
    Creates and initializes a new MT009 input message from sender to 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:
    
    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.7
  - MT009
```
public MT009(java.lang.String fin)
```
    Creates a new MT009 by parsing a String with the message content in its swift FIN format. If the fin parameter is null or the message cannot be parsed, the internal message object will be initialized (blocks will be created) but empty. If the string contains multiple messages, only the first one will be parsed.
    
    Parameters:
    
    fin - a string with the MT message in its FIN swift format
    
    Since:
    
    7.7
  - MT009
```
public MT009(java.io.InputStream stream)
      throws java.io.IOException
```
    Creates a new MT009 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding. If the message content is null or cannot be parsed, the internal message object will be initialized (blocks will be created) but empty. If the stream contains multiple messages, only the first one will be parsed.
    
    Parameters:
    
    stream - an input stream in UTF-8 encoding with the MT message in its FIN swift format.
    
    Throws:
    
    java.io.IOException - if the stream data cannot be read
    
    Since:
    
    7.7
  - MT009
```
public MT009(java.io.File file)
      throws java.io.IOException
```
    Creates a new MT009 by parsing a file with the message content in its swift FIN format. If the file content is null or cannot be parsed as a message, the internal message object will be initialized (blocks will be created) but empty. If the file contains multiple messages, only the first one will be parsed.
    
    Parameters:
    
    file - a file with the MT message in its FIN swift format.
    
    Throws:
    
    java.io.IOException - if the file content cannot be read
    
    Since:
    
    7.7
- Method Detail
  - parse
```
public static MT009 parse(MtSwiftMessage m)
```
    Creates an MT009 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT009 content
    
    Returns:
    
    the created object or null if the parameter is null
    
    Since:
    
    7.7
    
    See Also:
    
    MT009(String)
  - parse
```
public static MT009 parse(java.lang.String fin)
```
    Creates a new MT009 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT009 will have its internal message object initialized (blocks will be created) but empty. If the string contains multiple messages, only the first one will be parsed.
    
    Parameters:
    
    fin - a string with the MT message in its FIN swift format. fin may be null in which case this method returns null
    
    Returns:
    
    a new instance of MT009 or null if fin is null
    
    Since:
    
    7.7
  - parse
```
public static MT009 parse(java.io.InputStream stream)
                   throws java.io.IOException
```
    Creates a new MT009 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding. If the stream contains multiple messages, only the first one will be parsed.
    
    Parameters:
    
    stream - an input stream in UTF-8 encoding with the MT message in its FIN swift format.
    
    Returns:
    
    a new instance of MT009 or null if stream is null or the message cannot be parsed
    
    Throws:
    
    java.io.IOException - if the stream data cannot be read
    
    Since:
    
    7.7
  - parse
```
public static MT009 parse(java.io.File file)
                   throws java.io.IOException
```
    Creates a new MT009 by parsing a file with the message content in its swift FIN format. If the file contains multiple messages, only the first one will be parsed.
    
    Parameters:
    
    file - a file with the MT message in its FIN swift format.
    
    Returns:
    
    a new instance of MT009 or null if; file is null, does not exist, can't be read, is not a file or the message cannot be parsed
    
    Throws:
    
    java.io.IOException - if the file content cannot be read
    
    Since:
    
    7.7
  - getMessageType
```
public java.lang.String getMessageType()
```
    Returns this MT number.
    
    Specified by:
    
    getMessageType in class AbstractMT
    
    Returns:
    
    the message type number of this MT
    
    Since:
    
    6.4
  - append
```
public MT009 append(SwiftTagListBlock block)
```
    Add all tags from block to the end of the block4.
    
    Overrides:
    
    append in class AbstractMT
    
    Parameters:
    
    block - to append
    
    Returns:
    
    this object to allow method chaining
    
    Since:
    
    7.6
  - append
```
public MT009 append(Tag... tags)
```
    Add all tags to the end of the block4.
    
    Overrides:
    
    append in class AbstractMT
    
    Parameters:
    
    tags - to append
    
    Returns:
    
    this object to allow method chaining
    
    Since:
    
    7.6
  - append
```
public MT009 append(Field... fields)
```
    Add all the fields to the end of the block4.
    
    Overrides:
    
    append in class AbstractMT
    
    Parameters:
    
    fields - to append
    
    Returns:
    
    this object to allow method chaining
    
    Since:
    
    7.6
  - fromJson
```
public static MT009 fromJson(java.lang.String json)
```
    Creates an MT009 messages from its JSON representation.
    For generic conversion of JSON into the corresponding MT instance see AbstractMT.fromJson(String)
    
    Parameters:
    
    json - a JSON representation of an MT009 message
    
    Returns:
    
    a new instance of MT009
    
    Since:
    
    7.10.3
  - getField173
```
public Field173 getField173()
```
    Iterates through block4 fields and return the first one whose name matches 173, or null if none is found. The first occurrence of field 173 at MT009 is expected to be the only one.
    
    Returns:
    
    a Field173 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)

Class MT009

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

Constructor Summary

Method Summary

Methods inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

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

Methods inherited from class java.lang.Object

Field Detail

SRU

NAME

Constructor Detail

MT009

MT009

MT009

MT009

MT009

MT009

MT009

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

fromJson

getField173