AbstractSwiftMessage (Prowide Integrator API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.AbstractSwiftMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MtSwiftMessage, MxSwiftMessage
```
public abstract class AbstractSwiftMessage
extends Object
implements Serializable
```
Base class for common attributes of MT and MX SWIFT messages intended for messages persistence.
This class hierarchy is designed as a container of the raw message contents (xml for MX and FIN for MT) plus minimal message metadata. The extra data contains several common attributes for all messages, and the subclasses add additional information mainly to identify the specific message type.
This minimal abstraction make this model optimal for an ORM mapping (ex: for Hibernate) to store all messages in a single and simple table.

Since:

7.0

Author:

www.prowidesoftware.com

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`identifier` Message type identification as specify by SWIFT. For MT messages this will contain the three digits for the message type, ex: 103 For MX messages this will contain the business process, functionality, variant and version concatenated by a dot, ex: acmt.001.001.01
`static String`	`PROPERTY_NAME`
`protected String`	`receiver` Receivers BIC8 code. For MT messages this is the BIC8 portion of the receiver logical terminal; for outgoing messages the LT at block 2 is used, and for incoming messages it is the LT at block 1.
`protected String`	`sender` Senders BIC8 code. For MT messages this is the BIC8 portion of the sender logical terminal; for outgoing messages the LT at block 1 is used, and for incoming messages it is the LT at the MIR of block 2.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`AbstractSwiftMessage()` Empty constructor provided for ORM persistence.
`protected`	`AbstractSwiftMessage(File file)` Creates a new message reading the message the content from a file.
`protected`	`AbstractSwiftMessage(InputStream stream)` Creates a new message reading the message the content from an input stream, using UTF-8 as encoding.
`protected`	`AbstractSwiftMessage(String content)` Creates a new message reading the message the content from a string.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addNote(SwiftMessageNote n)` Adds a new note to the messages, initializing the notes list if necessary.
`void`	`addStatus(SwiftMessageStatusInfo status)` Adds a status to the message's status trail and current status attribute, initializing the statuses trail list if necessary.
`boolean`	`contains(Enum... statuses)` Tell if this message has any of the given statuses in his status trail
`boolean`	`contains(String... statuses)` Tell if this message has any of the given statuses in his status trail
`void`	`copyTo(AbstractSwiftMessage msg)` Copies attributes from the current object to msg.
`boolean`	`equals(Object obj)`
`SwiftMessageStatusInfo`	`findStatusInfo(String statusName)` Finds the first status info from the status trail, with the given name or returns `null` if not found
`String`	`getChecksum()`
`Calendar`	`getCreationDate()`
`MessageIOType`	`getDirection()`
`String`	`getFilename()`
`Long`	`getId()` Returns the persisted message unique identifier.
`String`	`getIdentifier()`
`String`	`getLastData()`
`String`	`getLastData(String... statuses)` Get the last saved status data of this message or empty string if not found
`Calendar`	`getLastModified()`
`String`	`getMessage()` Same as {`message()`}
`String`	`getMessageName()` Get the value of the property under the `PROPERTY_NAME` key or `null` if not found
`List<SwiftMessageNote>`	`getNotes()`
`String`	`getPaddedId()` Returns the internal unique id as fixed length string, padded with zeros.
`SwiftMessageStatusInfo`	`getPreviousStatusInfo()` Retrieves from the status trail, the status info before the current one; or `null` if none is found.
`Map<String,String>`	`getProperties()`
`String`	`getProperty(Enum key)`
`String`	`getProperty(String key)` Get the value of the property under the given key or `null` if the key is not found or its value is empty
`boolean`	`getPropertyBoolean(Enum key)`
`boolean`	`getPropertyBoolean(String key)` Returns true if the message has a property with the given key name and value "true"
`String`	`getReceiver()`
`String`	`getSender()`
`String`	`getStatus()` Get the name of the last status set to this message, or `null` if none is found.
`SwiftMessageStatusInfo`	`getStatusInfo()` Retrieves from the status trail, the current status info; or `null` if none is found.
`List<SwiftMessageStatusInfo>`	`getStatusTrail()`
`int`	`hashCode()`
`Boolean`	`isIncoming()`
`boolean`	`isInput()`
`boolean`	`isOutgoing()`
`Boolean`	`isOutput()`
`boolean`	`isStatus(Enum... statuses)` Tell if this message has any of the given statuses as current status
`boolean`	`isStatus(Enum status)` Returns true if the current status is equals to the parameter status
`boolean`	`isStatus(String... statuses)` Tell if this message has any of the given statuses as current status
`boolean`	`isStatus(String status)` Returns true if the current status is equals to the parameter status
`String`	`message()` Returns the internal swift message in its original raw format.
`abstract AbstractSwiftMessage`	`readFile(File file)` Deprecated. use the constructor `AbstractSwiftMessage(File)` instead
`void`	`sanityCheckProperties()` Iterate message properties and truncate all needed values issuing a log entry for each truncated one
`void`	`setChecksum(String checksum)`
`void`	`setCreationDate(Calendar creationDate)`
`void`	`setDirection(MessageIOType direction)`
`void`	`setFilename(String filename)`
`void`	`setId(Long id)` Used by the ORM to set the database unique identifier.
`void`	`setIdentifier(String identifier)`
`void`	`setLastModified(Calendar lastModified)`
`void`	`setMessage(String message)` Set the raw content of the message.
`void`	`setNotes(List<SwiftMessageNote> notes)`
`void`	`setProperties(Map<String,String> properties)`
`void`	`setProperty(Enum key, String value)`
`void`	`setProperty(String key, String value)` Sets a property using the given key and value, if the key exists the value is overwritten.
`void`	`setReceiver(String receiver)`
`void`	`setSender(String sender)`
`void`	`setStatus(String status)` Sets the status attribute.
`void`	`setStatus(SwiftMessageStatusInfo status)`
`void`	`setStatusTrail(List<SwiftMessageStatusInfo> statusTrail)`
`protected abstract 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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - identifier
```
protected String identifier
```
    Message type identification as specify by SWIFT.
    For MT messages this will contain the three digits for the message type, ex: 103 For MX messages this will contain the business process, functionality, variant and version concatenated by a dot, ex: acmt.001.001.01
  - sender
```
protected String sender
```
    Senders BIC8 code.
    For MT messages this is the BIC8 portion of the sender logical terminal; for outgoing messages the LT at block 1 is used, and for incoming messages it is the LT at the MIR of block 2. For MX messages this is the (capitalized) BIC information in the "From" tag of the Application Header.
  - receiver
```
protected String receiver
```
    Receivers BIC8 code.
    For MT messages this is the BIC8 portion of the receiver logical terminal; for outgoing messages the LT at block 2 is used, and for incoming messages it is the LT at block 1. For MX messages this is the (capitalized) BIC information in the "To" tag of the Application Header.
  - PROPERTY_NAME
```
public static final transient String PROPERTY_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - AbstractSwiftMessage
```
public AbstractSwiftMessage()
```
    Empty constructor provided for ORM persistence. On most situations this objects are constructed with message data as parameter.
    
    Since:
    
    7.7
  - AbstractSwiftMessage
```
protected AbstractSwiftMessage(String content)
```
    Creates a new message reading the message the content from a string. Uses abstract method @link {updateFromMessage()} to fill the specific metadata attributes.
    The complete string content will be read and set as raw message content, but if the stringt contains multiple messages, only the first one will be used for metadata and message identification.
    
    Parameters:
    content - a swift message content
    Since:
    
    7.7
  - AbstractSwiftMessage
```
protected AbstractSwiftMessage(InputStream stream)
                        throws IOException
```
    Creates a new message reading the message the content from an input stream, using UTF-8 as encoding. Uses abstract method {updateFromMessage()} to fill the specific metadata attributes.
    The complete stream content will be read and set as raw message content, but if the stream contains multiple messages, only the first one will be used for metadata and message identification.
    
    Parameters:
    stream -
    
    Throws:
    
    IOException
    Since:
    
    7.7
  - AbstractSwiftMessage
```
protected AbstractSwiftMessage(File file)
                        throws IOException
```
    Creates a new message reading the message the content from a file. Uses abstract method {updateFromMessage()} to fill the specific metadata attributes.
    The complete file content will be read and set as raw message content, but if the file contains multiple messages, only the first one will be used for metadata and message identification.
    
    Parameters:
    file - an existing file name containing only one message.
    
    Throws:
    
    IOException
    Since:
    
    7.7
- Method Detail
  - updateFromMessage
```
protected abstract 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. If the message content is invalid the metadata will be left blank.
    
    Since:
    
    7.7
  - getId
```
public Long getId()
```
    Returns the persisted message unique identifier.
  - setId
```
public void setId(Long id)
```
    Used by the ORM to set the database unique identifier.
  - getMessage
```
public String getMessage()
```
    Same as {message()}
  - message
```
public String message()
```
    Returns the internal swift message in its original raw format.
    
    Returns:
    raw content of the message
    Since:
    
    7.7
  - setMessage
```
public void setMessage(String message)
```
    Set the raw content of the message.
    
    Parameters:
    message - raw content of the message
  - getIdentifier
```
public String getIdentifier()
```
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - getChecksum
```
public String getChecksum()
```
  - setChecksum
```
public void setChecksum(String checksum)
```
  - getLastModified
```
public Calendar getLastModified()
```
  - setLastModified
```
public void setLastModified(Calendar lastModified)
```
  - getCreationDate
```
public Calendar getCreationDate()
```
  - setCreationDate
```
public void setCreationDate(Calendar creationDate)
```
  - getNotes
```
public List<SwiftMessageNote> getNotes()
```
  - setNotes
```
public void setNotes(List<SwiftMessageNote> notes)
```
  - getProperties
```
public Map<String,String> getProperties()
```
  - setProperties
```
public void setProperties(Map<String,String> properties)
```
  - getStatusTrail
```
public List<SwiftMessageStatusInfo> getStatusTrail()
```
  - setStatusTrail
```
public void setStatusTrail(List<SwiftMessageStatusInfo> statusTrail)
```
  - getStatus
```
public String getStatus()
```
    Get the name of the last status set to this message, or null if none is found.
  - setStatus
```
public void setStatus(String status)
```
    Sets the status attribute. Notice that this method does not update the status trail.
    
    Parameters:
    status -
    See Also:
    addStatus(SwiftMessageStatusInfo)
  - getSender
```
public String getSender()
```
  - setSender
```
public void setSender(String sender)
```
  - getReceiver
```
public String getReceiver()
```
  - setReceiver
```
public void setReceiver(String receiver)
```
  - getDirection
```
public MessageIOType getDirection()
```
  - setDirection
```
public void setDirection(MessageIOType direction)
```
  - getFilename
```
public String getFilename()
```
  - setFilename
```
public void setFilename(String filename)
```
  - getMessageName
```
public String getMessageName()
```
    Get the value of the property under the PROPERTY_NAME key or null if not found
  - addStatus
```
public void addStatus(SwiftMessageStatusInfo status)
```
    Adds a status to the message's status trail and current status attribute, initializing the statuses trail list if necessary.
    
    Parameters:
    status - the status to add
  - isOutgoing
```
public boolean isOutgoing()
```
    Returns:
    true if the message is outgoing (sent to SWIFT), false other case; using the direction attribute.
  - isInput
```
public boolean isInput()
```
    See Also:
    isOutgoing()
  - isIncoming
```
public Boolean isIncoming()
```
    Returns:
    true if the message is incoming (received from SWIFT), false other case; using the direction attribute.
  - isOutput
```
public Boolean isOutput()
```
    See Also:
    isIncoming()
  - setStatus
```
public void setStatus(SwiftMessageStatusInfo status)
```
    See Also:
    addStatus(SwiftMessageStatusInfo)
  - isStatus
```
public boolean isStatus(String status)
```
    Returns true if the current status is equals to the parameter status
    
    Parameters:
    status -
  - isStatus
```
public boolean isStatus(Enum status)
```
    Returns true if the current status is equals to the parameter status
    
    Parameters:
    status -
  - getStatusInfo
```
public SwiftMessageStatusInfo getStatusInfo()
```
    Retrieves from the status trail, the current status info; or null if none is found.
  - getPreviousStatusInfo
```
public SwiftMessageStatusInfo getPreviousStatusInfo()
```
    Retrieves from the status trail, the status info before the current one; or null if none is found.
  - contains
```
public boolean contains(Enum... statuses)
```
    Tell if this message has any of the given statuses in his status trail
    
    Parameters:
    statuses - a list of statuses to check in the status trail
  - contains
```
public boolean contains(String... statuses)
```
    Tell if this message has any of the given statuses in his status trail
    
    Parameters:
    statuses - a list of statuses to check in the status trail
  - isStatus
```
public boolean isStatus(String... statuses)
```
    Tell if this message has any of the given statuses as current status
    
    Parameters:
    statuses -
  - isStatus
```
public boolean isStatus(Enum... statuses)
```
    Tell if this message has any of the given statuses as current status
    
    Parameters:
    statuses -
  - getLastData
```
public String getLastData(String... statuses)
```
    Get the last saved status data of this message or empty string if not found
    
    Parameters:
    statuses - an array of statuses to check data into, if null all message statuses are checked for data
    
    Returns:
    the most recent (last) status data found
  - getLastData
```
public String getLastData()
```
  - findStatusInfo
```
public SwiftMessageStatusInfo findStatusInfo(String statusName)
```
    Finds the first status info from the status trail, with the given name or returns null if not found
  - addNote
```
public void addNote(SwiftMessageNote n)
```
    Adds a new note to the messages, initializing the notes list if necessary.
    
    Parameters:
    n - note to add
  - sanityCheckProperties
```
public void sanityCheckProperties()
```
    Iterate message properties and truncate all needed values issuing a log entry for each truncated one
  - getProperty
```
public String getProperty(String key)
```
    Get the value of the property under the given key or null if the key is not found or its value is empty
  - getProperty
```
public String getProperty(Enum key)
```
    See Also:
    getProperty(String)
  - setProperty
```
public void setProperty(String key,
               String value)
```
    Sets a property using the given key and value, if the key exists the value is overwritten.
  - setProperty
```
public void setProperty(Enum key,
               String value)
```
    See Also:
    setProperty(String, String)
  - getPropertyBoolean
```
public boolean getPropertyBoolean(String key)
```
    Returns true if the message has a property with the given key name and value "true"
  - getPropertyBoolean
```
public boolean getPropertyBoolean(Enum key)
```
    See Also:
    getPropertyBoolean(String)
  - getPaddedId
```
public String getPaddedId()
```
    Returns the internal unique id as fixed length string, padded with zeros.
    
    Returns:
    string with 10 characters with this message identifier
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - readFile
```
public abstract AbstractSwiftMessage readFile(File file)
                                       throws IOException
```
    Deprecated. use the constructor AbstractSwiftMessage(File) instead
    
    Throws:
    
    IOException
  - copyTo
```
public void copyTo(AbstractSwiftMessage msg)
```
    Copies attributes from the current object to msg. Attributes:
    - checksum
    - creationDate
    - direction
    - filename
    - id
    - identifier
    - lastModified
    - message
    - notes
    - properties
    - receiver
    - sender
    - status
    - statusTrail
    Parameters:
    msg -
    Since:
    
    7.7

Class AbstractSwiftMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

identifier

sender

receiver

PROPERTY_NAME

Constructor Detail

AbstractSwiftMessage

AbstractSwiftMessage

AbstractSwiftMessage

AbstractSwiftMessage

Method Detail

updateFromMessage

getId

setId

getMessage

message

setMessage

getIdentifier

setIdentifier

getChecksum

setChecksum

getLastModified

setLastModified

getCreationDate

setCreationDate

getNotes

setNotes

getProperties

setProperties

getStatusTrail

setStatusTrail

getStatus

setStatus

getSender

setSender

getReceiver

setReceiver

getDirection

setDirection

getFilename

setFilename

getMessageName

addStatus

isOutgoing

isInput

isIncoming

isOutput

setStatus

isStatus

isStatus

getStatusInfo

getPreviousStatusInfo

contains

contains

isStatus

isStatus

getLastData

getLastData

findStatusInfo

addNote

sanityCheckProperties

getProperty

getProperty

setProperty

setProperty

getPropertyBoolean

getPropertyBoolean

getPaddedId

hashCode

equals

readFile

copyTo