See: Description
| Interface | Description |
|---|---|
| TagVisitor |
| Class | Description |
|---|---|
| AbstractMessage |
Base class for hierarchy of specific MT and MX classes.
|
| AbstractSwiftMessage |
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. |
| BIC |
Helper class to process BIC related information.
|
| IBAN |
Utility class to validate IBAN codes.
|
| ISOCountries |
Helper class to validate ISO Country codes
|
| ISOCurrencies |
Helper class to validate ISO Currency codes
|
| LogicalTerminalAddress |
Identifies a logical channel connection to SWIFT, and the network uses it
for addressing.
|
| MIR |
This class models and parses the Message Input Reference (MIR),
String of 28 characters, always local to the sender of the message.
|
| MOR |
This class models and parses the Message Output Reference (MOR).
|
| MtId |
Class for identification of MT messages.
|
| MtSwiftMessage |
Container of raw representations of an MT (ISO 15022) SWIFT message, intended for message persistence.
|
| MxId |
Class for identification of MX messages.
Composed by the business process (business area), functionality (message type), variant and version. |
| MxNode |
This class represents a node element within a tree of MX message.
|
| MxSwiftMessage |
Container of raw representation of an MX (ISO 20022) SWIFT message, intended for message persistence.
|
| PropertyResource |
Common code for subclasses.
|
| SequenceNode |
Node that identifies a sequence inside a message.
|
| SwiftBlock |
Base class for a generic SWIFT block.
This is an abstract class so specific block classes for each block (block 1, 2, 3, etc...) should be instantiated. Instances of this class may have a list of unparsed texts (UnparsedTextList). |
| SwiftBlock1 |
Base class for SWIFT Basic Header Block (block 1).
|
| SwiftBlock2 |
Base class for SWIFT Application Header Block (block 2).
The Application Header contains information about the message type and the destination of the message. |
| SwiftBlock2Input |
Base class for SWIFT Application Header Block (block 2)
for INPUT (to SWIFT).
This block is used to construct messages that are going to be input to the SWIFT network. |
| SwiftBlock2Output |
Base class for SWIFT Application Header Block (block 2)
for OUTPUT (from SWIFT).
This block is used to construct messages that have been output from the SWIFT network. |
| SwiftBlock3 |
Base class for SWIFT User Header Block (block 3).
This block is optional, and contains special processing instructions. |
| SwiftBlock4 |
Base class for SWIFT Body Block (block 4).
This block is where the actual message content is specified and is what most users see. |
| SwiftBlock5 |
Base class for SWIFT Trailer Block (block 5).
Each SWIFT message has one or more trailers as required by the message exchange and security requirements. |
| SwiftBlockUser |
Base class for SWIFT User "ad-hoc" Blocks (blocks with number other than 1-5 or names).
The assumption is that these User Defined Blocks are used and defined as tag blocks (meaning that these blocks behave like a block 3 or 5). NOTE: this is not part of SWIFT standard, but seems to be common practice for users to append some locally defined blocks to annotate messages in a semi-compatible way (for example: add block 9 for some local information or block "S" for system reference). |
| SwiftMessage |
Base class for swift messages.
This class is a generic data structure container for SWIFT messages. |
| SwiftMessageNote |
Comments associated to a message for application only usage (not part of the standard).
|
| SwiftMessageRevision |
A revision is a snapshot of message content and is used to track the history of changes in a message.
|
| SwiftMessageStatusInfo |
Status tracking record for application only usage (not part of the standard).
The status name identifier is modeled with plain String, nevertheless the usage of an application specific enumeration is encourage; constructors and methods with raw Enum parameters are provided. |
| SwiftMessageUtils |
Utility methods that provide higher level access to
SwiftMessage |
| SwiftServiceId |
Class to hold valid service id values.
|
| SwiftTagListBlock |
Base class for SWIFT blocks that contain and arbitrary set of fields (3, 4, 5 and user blocks).
Specific block classes for each block should be instantiated. |
| SwiftValueBlock |
Base class for SWIFT blocks that contain its fields concatenated as a single fixed length value; blocks 1 and 2.
This is an abstract class so specific block classes for each block should be instantiated. |
| Tag |
Representation of a swift tag (also 'field' in computer terms) in a message.
|
| UnparsedTextList |
List of unparsed texts for messages, blocks or tags.
For performance reasons, the unparsed texts are stored directly as strings inside this list object. |
| Enum | Description |
|---|---|
| FileFormat |
Supported file formats in the
AbstractSwiftMessage hierarchy. |
| MessageIOType |
Enumeration of messages flow types.
|
| MessageStandardType |
Enumeration of messages standard types.
|
| MxBusinessProcess |
SWIFT business process classification for MX messages.
|
| SwiftBlock1Field |
Full qualified names for attributes in block 1.
|
| SwiftBlock2.MessagePriority |
Message priority values
|
| SwiftBlock2Field |
Full qualified names for attributes in block 2.
|
| SwiftBlock2Input.DeliveryMonitoring |
Delivery monitoring values
|
| SwiftBlock2InputField |
Full qualified names for attributes in block 2 input.
|
| SwiftBlock2OutputField |
Full qualified names for attributes in block 2 output.
|
Core package with classes that model SWIFT messages.
This is a core package that provides classes to hold the structure for all SWIFT messages.
It is basically a three level hierarchy representing the primary elements that defines a SWIFT message; the message itself, it's blocks, and the tag (or fields) inside each block.
The object model is quite generic and loosely coupled to particular MT structures, that require minimal construction constrains.
SwiftMessage The top level object in the hierarchy is the SwiftMessage, which contains attributes to hold up to five SwiftBlock objects and optionally an arbitrary number of SwiftBlockUser (see below).
SwiftBlock Each block class is a subclass of SwiftBlock. There is a small hierarchy of different block classes, grouped by functionality. For example, in FIN messages, block 1 is fixed length a string, and block 4 is a set of tags. An abstract class hierarchy represents this block taxonomy and specific subclasses exist for each of the five possible SWIFT blocks.
SwiftValueBlock In the hierarchy the SwiftValueBlock is a container for blocks with fixed length string value. Its child classes implement then specific attributes for each field of the string value. For Block1 for example you have getters and setters for serviceId, applicationId, etc..
SwiftTagListBlock And SwiftTagListBlock is a container for blocks conformed by list of Tag. A tag is basically a pair of datums, the name of the tag (for example; "59", "13C", "23E") and a value. Generic getters are provided to obtain individual tags or lists containing filtered subsets of tags.
SwiftBlockUser SwiftBlockUser is not part of SWIFT standard, but seems to be common practice for users to append some locally defined blocks to annotate messages in an almost-compatible way (for example: add block 9 for some local information or block "S" for system reference). Contents of this block are opaque for WIFE, but they are preserved so applications can still have them available
Some methods support a wildcard notation. This allows to refer to many fields in one name.
When 'a' notation, AKA wildcard notattion is supported, "50a" will match the names: 50, 50A, 50B, 50D. It is very important to understand that 'a' functions as a wildcard while 'A' is a letter option, just as B C or any uppercase letter. For those who are confused about this notation, it comes from the standards documentation. Specificaction mention '50a' with the same meaning that is used here.