AbstractMX (Prowide Integrator API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.AbstractMessage
- - com.prowidesoftware.swift.model.mx.AbstractMX

All Implemented Interfaces:

IDocument
```
public abstract class AbstractMX
extends AbstractMessage
implements IDocument
```
Base class for specific MX messages.
IMPORTANT: An MX message is conformed by a set of optional headers and a message payload or document with the actual specific MX message. The name of the envelope element that binds a Header to the message to which it applies is implementation/network specific and not part of the scope of this model.
This class provides the base container model for MX messages including an attribute for the header. Further it supports both versions for the header; the SWIFT Application Header (legacy) and the ISO Business Application Header.
Subclasses in Prowide Integrator SDK implement the Document portion of each specific MX message type.
Serialization of this model into XML text can be done for the with or without the header portion. When the header is set and included into the serialization, the container root element must be provided.

Since:

7.6

Author:

www.prowidesoftware.com

See Also:
AbstractMT

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractMX()

protected AbstractMX(BusinessHeader businessHeader)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractMX()`
`protected`	`AbstractMX(BusinessHeader businessHeader)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`document()` Get this message document as an XML string.
`String`	`document(String prefix, boolean includeXMLDeclaration)` Get this message document as an XML string.
`Element`	`element()`
`BusinessHeader`	`getBusinessHeader()`
`abstract String`	`getBusinessProcess()` get the Alphabetic code in four positions (fixed length) identifying the Business Process
`abstract Class[]`	`getClasses()` Get the classes associated with this message
`abstract int`	`getFunctionality()` Get the code identifying the Message Functionality
`MxId`	`getMxId()` Returns the MX message identification. Composed by the business process, functionality, variant and version.
`abstract String`	`getNamespace()` Get the XML namespace of the message
`abstract int`	`getVariant()` Get the Message variant
`abstract int`	`getVersion()` Get the message version
`String`	`header()` Get this message business header as an XML string.
`String`	`header(String prefix, boolean includeXMLDeclaration)` Get this message business header as an XML string.
`String`	`message()` Get this message document as an XML string (headers not included).
`String`	`message(String rootElement)` Same as `message(String)` with includeXMLDeclaration set to true
`protected static String`	`message(String namespace, AbstractMX obj, Class[] classes, String prefix, boolean includeXMLDeclaration)`
`String`	`message(String rootElement, boolean includeXMLDeclaration)` Get this message as an XML string.
`static AbstractMX`	`parse(File file, MxId id)` Parses a file content into a specific instance of Mx.
`static AbstractMX`	`parse(String xml, MxId id)` Parses the XML string containing the Document element of an MX message into a specific instance of MX message object.
`protected static AbstractMX`	`read(Class<? extends AbstractMX> targetClass, String xml, Class[] classes)`
`void`	`setBusinessHeader(BusinessHeader businessHeader)`
`void`	`write(File file)` Writes the message document content into a file in XML format (headers not included).
`void`	`write(OutputStream stream)` Writes the message document content into a file in XML format, encoding content in UTF-8 (headers not included).
`Source`	`xmlSource()` Convenience method to get this message XML as javax.xml.transform.Source.

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, toString, wait, wait, wait

- Constructor Detail
  - AbstractMX
```
protected AbstractMX()
```
  - AbstractMX
```
protected AbstractMX(BusinessHeader businessHeader)
```
- Method Detail
  - message
```
protected static String message(String namespace,
             AbstractMX obj,
             Class[] classes,
             String prefix,
             boolean includeXMLDeclaration)
```
  - read
```
protected static AbstractMX read(Class<? extends AbstractMX> targetClass,
              String xml,
              Class[] classes)
```
  - getClasses
```
public abstract Class[] getClasses()
```
    Get the classes associated with this message
    
    Since:
    
    7.7
  - getNamespace
```
public abstract String getNamespace()
```
    Get the XML namespace of the message
    
    Since:
    
    7.7
  - getBusinessProcess
```
public abstract String getBusinessProcess()
```
    get the Alphabetic code in four positions (fixed length) identifying the Business Process
    
    Returns:
    the business process of the implementing class
    Since:
    
    7.7
  - getFunctionality
```
public abstract int getFunctionality()
```
    Get the code identifying the Message Functionality
    
    Returns:
    the set functionality or null if not set
    Since:
    
    7.7
  - getVariant
```
public abstract int getVariant()
```
    Get the Message variant
    
    Returns:
    the set variant or null if not set
    Since:
    
    7.7
  - getVersion
```
public abstract int getVersion()
```
    Get the message version
    
    Returns:
    the set vesion or null if not set
    Since:
    
    7.7
  - message
```
public String message()
```
    Get this message document as an XML string (headers not included). The XML will include the XML declaration, the corresponding namespace and a "Doc" prefix for the namespace.
    
    Since:
    
    7.7
    
    See Also:
    message(String, boolean)
  - message
```
public String message(String rootElement,
             boolean includeXMLDeclaration)
```
    Get this message as an XML string.
    If the business header is set, the created XML will include both the header and the document elements, under a default root element.
    If the header is not present, the created XMl will only include the document.
    Both header and document are generated with namespace declaration and default prefixes.
    IMPORTANT: The name of the envelope element that binds a Header to the message to which it applies is implementation/network specific. The header root element ‘AppHdr’ and the ISO 20022 MessageDefinition root element ‘Document’ must always be sibling elements in any XML document, with the AppHdr element preceding the Document element.
    
    Parameters:
    rootElement - optional specification of the root element
    
    Returns:
    created XML
    Since:
    
    7.8
  - message
```
public String message(String rootElement)
```
    Same as message(String) with includeXMLDeclaration set to true
    
    Since:
    
    7.8
  - header
```
public String header()
```
    Get this message business header as an XML string.
    The XML will not include the XML declaration, and will include de namespace as default (without prefix).
    
    Returns:
    the serialized header or null if header is not set
    Since:
    
    7.8
    
    See Also:
    header(String, boolean)
  - header
```
public String header(String prefix,
            boolean includeXMLDeclaration)
```
    Get this message business header as an XML string.
    
    Parameters:
    prefix - optional prefix for namespace (empty by default)
    includeXMLDeclaration - true to include the XML declaration (false by default)
    
    Returns:
    header serialized into XML string or null if neither header version is present
    Since:
    
    7.8
    
    See Also:
    BusinessHeader.xml(String, boolean)
  - document
```
public String document()
```
    Get this message document as an XML string. Same as message()
    
    Since:
    
    7.8
  - document
```
public String document(String prefix,
              boolean includeXMLDeclaration)
```
    Get this message document as an XML string.
    
    Parameters:
    prefix - optional prefix for namespace (empty by default)
    includeXMLDeclaration - true to include the XML declaration (false by default)
    
    Returns:
    document serialized into XML string or null if errors occur during serialization
    Since:
    
    7.8
  - xmlSource
```
public Source xmlSource()
```
    Convenience method to get this message XML as javax.xml.transform.Source. Notice this method will return only the document element of the message (headers not included).
    
    Returns:
    null if message() returns null or StreamSource in other case
    Since:
    
    7.7
    
    See Also:
    message()
  - write
```
public void write(File file)
           throws IOException
```
    Writes the message document content into a file in XML format (headers not included).
    
    Parameters:
    file - a not 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 document content into a file in XML format, encoding content in UTF-8 (headers not included).
    
    Parameters:
    stream - a non null stream to write
    
    Throws:
    
    IOException
    Since:
    
    7.7
  - getBusinessHeader
```
public BusinessHeader getBusinessHeader()
```
    Returns:
    the business header or null if not set
    Since:
    
    7.7
  - setBusinessHeader
```
public void setBusinessHeader(BusinessHeader businessHeader)
```
    Parameters:
    businessHeader - the header to set
    Since:
    
    7.8
  - getMxId
```
public MxId getMxId()
```
    Returns the MX message identification.
    Composed by the business process, functionality, variant and version.
    
    Returns:
    the constructed message id
    Since:
    
    7.7
  - element
```
public Element element()
```
  - parse
```
public static AbstractMX parse(String xml,
               MxId id)
```
    Parses the XML string containing the Document element of an MX message into a specific instance of MX message object.
    If the string is empty, does not contain an MX document, the message type cannot be detected or an error occur reading and parsing the message content; this method returns null.
    The implementation detects the message type and uses reflection to call the parser in the specific Mx subclass.
    IMPORTANT: For the moment this is supported only in Prowide Integrator. To parse XML into the generic MxNode structure, or to parse business headers check MxParser
    
    Parameters:
    xml - string a string containing the Document of an MX message in XML format
    id - optional parameter to indicate the specific MX type to create; autodetected from namespace if null.
    
    Returns:
    parser message or null if string content could not be parsed into an Mx
    Since:
    
    7.8.4
  - parse
```
public static AbstractMX parse(File file,
               MxId id)
                        throws IOException
```
    Parses a file content into a specific instance of Mx.
    IMPORTANT: For the moment this is supported only in Prowide Integrator. To parse XML into the generic MxNode structure, or to parse business headers check MxParser
    
    Parameters:
    file - a file containing a swift MX message
    id - optional parameter to indicate the specific MX type to create; autodetected from namespace if null.
    
    Returns:
    parser message or null if file content could not be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.8.4
    
    See Also:
    parse(String, MxId)

Class AbstractMX

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

AbstractMX

AbstractMX

Method Detail

message

read

getClasses

getNamespace

getBusinessProcess

getFunctionality

getVariant

getVersion

message

message

message

header

header

document

document

xmlSource

write

write

getBusinessHeader

setBusinessHeader

getMxId

element

parse

parse