MxParser (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.io.parser.MxParser

```
public class MxParser
extends java.lang.Object
```
Basic parser for 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 the parser.

This parser has three main utilities;
1. The first one to convert the message into an MxNode tree. This is a generic structured representation of the complete content that can be used to get specific items by xpath. It parses the complete tree including both payload and overhead information (wrappers, if any, application header and body content).
2. The second utility is to parse the application header extract of the XML into a model object. Notice the application header is mainly used to identify the specific message, and two versions are supported; the legacy SWIFT ApplicationHeader and the ISO BusinessApplicationHeaderV01.
3. The third one is to provide convenient API to detect the specific Mx message type, to analize the payload structure and to strip the document or header portions from the XML in a lightweight and efficient way.
Notice that support for MX in Prowide Core is limited. Complete model and parser implementation for each MX message type is implemented into subclasses of AbstractMX by Prowide Integrator.
Since:

7.6

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class MxParser.MxStructureInfo
Helper bean used by analizeMessage() to return structure information from an MX message

Nested Classes
Modifier and Type	Class and Description
`class`	`MxParser.MxStructureInfo` Helper bean used by `analizeMessage()` to return structure information from an MX message

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DOCUMENT_LOCALNAME

static java.lang.String HEADER_LOCALNAME

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DOCUMENT_LOCALNAME`
`static java.lang.String`	`HEADER_LOCALNAME`

Constructor Summary

Constructors
Constructor and Description
`MxParser()` Deprecated. the generic constructor is discouraged, use a constructor with specific source parameter instead
`MxParser(java.io.File file)` Construct a parser for a file containing a single MX message
`MxParser(java.io.InputStream stream)` Construct a parser for a stream containing a single MX message
`MxParser(java.lang.String message)` Creates the parser initializing its content source from the given string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MxParser.MxStructureInfo`	`analizeMessage()` Convenient API to get structure information from an MX message.
`MxId`	`detectMessage()` Takes an xml with an MX message and detects the specific message type parsing just the namespace from the Document element.
`static java.lang.String`	`getBICFromDN(java.lang.String dn)` Distinguished Name structure: cn=name,ou=payment,o=bank,o=swift Example: o=spxainjj,o=swift
`MxPayload`	`mx()` Deprecated.
`MxNode`	`parse()` Non-namespace aware parse. Parses the complete message content into an `MxNode` tree structure.
`MxNode`	`parse(java.io.InputStream stream)` Deprecated. initialize the parser with the stream instead an call the generic `parse()` method
`MxNode`	`parse(java.io.Reader reader)` Deprecated. initialize the parser with the reader instead an call the generic `parse()` method
`ApplicationHeader`	`parseApplicationHeader()` Parses the application header (SWIFT legacy) from the internal message source.
`static ApplicationHeader`	`parseApplicationHeader(MxNode tree)` Parses the application header (SWIFT legacy) from the parameter node.
`BusinessApplicationHeaderV01`	`parseBusinessApplicationHeaderV01()` Parses the application header (ISO) from the internal message source.
`static BusinessApplicationHeaderV01`	`parseBusinessApplicationHeaderV01(MxNode tree)` Parses the application header (ISO) from the parameter node.
`BusinessHeader`	`parseBusinessHeader()` Detects the type of header and parses it as a legacy SWIFT Application Header or ISO Business Application Header.
`static BusinessHeader`	`parseBusinessHeader(org.w3c.dom.Element e)` Parse the business header from an XML Element node
`MxPayload`	`payload()` Deprecated. use `stripDocument()` and `stripHeader()` instead
`java.lang.String`	`stripDocument()` Helper API to strip Document portion of message XML.
`java.lang.String`	`stripHeader()` Helper API to strip AppHdr portion of message XML.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HEADER_LOCALNAME
```
public static final java.lang.String HEADER_LOCALNAME
```
    Since:
    
    7.8.4
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_LOCALNAME
```
public static final java.lang.String DOCUMENT_LOCALNAME
```
    Since:
    
    7.8.4
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MxParser
```
@Deprecated
 @ProwideDeprecated(phase4=_2018)
public MxParser()
```
    Deprecated. the generic constructor is discouraged, use a constructor with specific source parameter instead
  - MxParser
```
public MxParser(java.io.File file)
         throws java.io.IOException
```
    Construct a parser for a file containing a single MX message
    
    Parameters:
    
    file - the file containing a single unit of a message
    
    Throws:
    
    java.io.IOException - if an error occurs during the read of the file
    
    Since:
    
    7.7
  - MxParser
```
public MxParser(java.io.InputStream stream)
         throws java.io.IOException
```
    Construct a parser for a stream containing a single MX message
    
    Parameters:
    
    stream - non null stream containing a single unit of message
    
    Throws:
    
    java.io.IOException
  - MxParser
```
public MxParser(java.lang.String message)
```
    Creates the parser initializing its content source from the given string.
    
    Since:
    
    7.7
- Method Detail
  - parse
```
@Deprecated
 @ProwideDeprecated(phase4=_2018)
public MxNode parse(java.io.InputStream stream)
```
    Deprecated. initialize the parser with the stream instead an call the generic parse() method
    
    Initializes the parser with the given stream, and returns its parsed content.
    
    Since:
    
    7.6
  - parse
```
@Deprecated
 @ProwideDeprecated(phase4=_2018)
public MxNode parse(java.io.Reader reader)
                                                           throws java.io.IOException
```
    Deprecated. initialize the parser with the reader instead an call the generic parse() method
    
    Initializes the parser with the given reader, and returns its parsed content.
    
    Throws:
    
    java.io.IOException
    
    Since:
    
    7.6
  - parse
```
public MxNode parse()
```
    Non-namespace aware parse.
    Parses the complete message content into an MxNode tree structure. The parser should be initialized with a valid source.
    
    Since:
    
    7.7
  - payload
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public MxPayload payload()
```
    Deprecated. use stripDocument() and stripHeader() instead
  - parseBusinessHeader
```
public BusinessHeader parseBusinessHeader()
```
    Detects the type of header and parses it as a legacy SWIFT Application Header or ISO Business Application Header. Uses the namespace (if present) or an heuristic based on tags names.
    By default ISO Business Application Header is expected and assumed for the AppHdr tag.
    
    Returns:
    
    parsed header or null if the content cannot be parsed or the header is not present in the XML
  - parseBusinessHeader
```
public static BusinessHeader parseBusinessHeader(org.w3c.dom.Element e)
```
    Parse the business header from an XML Element node
    
    Since:
    
    7.8
    
    See Also:
    
    parseBusinessHeader()
  - parseApplicationHeader
```
public ApplicationHeader parseApplicationHeader()
```
    Parses the application header (SWIFT legacy) from the internal message source.
    
    Returns:
    
    parsed header or null if the content cannot be parsed or the header is not present in the XML
    
    See Also:
    
    parseBusinessHeader()
  - parseApplicationHeader
```
public static ApplicationHeader parseApplicationHeader(MxNode tree)
```
    Parses the application header (SWIFT legacy) from the parameter node.
    
    Returns:
    
    parsed header or null if the content cannot be parsed or the header is not present in the XML
    
    See Also:
    
    parseBusinessHeader()
  - parseBusinessApplicationHeaderV01
```
public BusinessApplicationHeaderV01 parseBusinessApplicationHeaderV01()
```
    Parses the application header (ISO) from the internal message source.
    
    Returns:
    
    parsed header or null if the content cannot be parsed or the header is not present in the XML
    
    See Also:
    
    parseBusinessHeader()
  - parseBusinessApplicationHeaderV01
```
public static BusinessApplicationHeaderV01 parseBusinessApplicationHeaderV01(MxNode tree)
```
    Parses the application header (ISO) from the parameter node.
    
    Returns:
    
    parsed header or null if the content cannot be parsed or the header is not present in the XML
    
    See Also:
    
    parseBusinessHeader()
  - detectMessage
```
public MxId detectMessage()
```
    Takes an xml with an MX message and detects the specific message type parsing just the namespace from the Document element. If the Document element is not present, or without the namespace or if the namespace url contains invalid content it will return null.
    
    Example of a recognizable Document element:
    
    The implementation is intended to be lightweight and efficient, based on XMLStreamReader
    
    Returns:
    
    id with the detected MX message type or null if it cannot be determined.
    
    Since:
    
    7.7
  - analizeMessage
```
public MxParser.MxStructureInfo analizeMessage()
```
    Convenient API to get structure information from an MX message.
    This can be helpful when the actual content of an XML is unknown and some preprocessing of the XML must be done in order to parse or validate its content properly.
    
    The implementation is intended to be lightweight and efficient, based on XMLStreamReader
    
    If the message contains more than one Document element, the first one will be picked. The same applies for the header, only the first AppHdr will be picked
    
    Since:
    
    7.8.4
  - mx
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public MxPayload mx()
```
    Deprecated.
  - getBICFromDN
```
public static java.lang.String getBICFromDN(java.lang.String dn)
```
    Distinguished Name structure: cn=name,ou=payment,o=bank,o=swift
    Example: o=spxainjj,o=swift
    
    Parameters:
    
    dn - the DN element content
    
    Returns:
    
    returns capitalized "bank", in the example SPXAINJJ
  - stripDocument
```
public java.lang.String stripDocument()
```
    Helper API to strip Document portion of message XML.
    This API is convenient when only the Document element of an MX message is needed and the wrapper/payload structure is unknown.
    
    This implementation is intended to be lightweight and efficient so it actually does a simple substring operation on the XML using information provided by the result of analizeMessage(). The XML is not converted into DOM.
    If the message contains more than one Document element the expected result is as follows:
    - If the documents are nested (this can happen for example when an additional MX message is provided within a supplementary data element within the main MX) then the outermost Document will be returned.
    - If the documents are not-nested (weird situation) the result might be not well-formed
    Returns:
    
    XML with Document element of the Mx message or null if message is blank or invalid
    
    Since:
    
    7.8.4
  - stripHeader
```
public java.lang.String stripHeader()
```
    Helper API to strip AppHdr portion of message XML.
    This API is convenient when only the header element of an MX message is needed and the wrapper/payload structure is unknown.
    
    To gather the header already parsed into objects see parseBusinessHeader()
    
    This implementation is intended to be lightweight and efficient so it actually does a simple substring operation on the XML using information provided by the result of analizeMessage(). The XML is not converted into DOM.
    If the message contains more than one AppHdr element the expected result is as follows:
    - If the headers are not nested, the first one will be returned.
    - If the headers are nested (weird situation) the result might be not well-formed
    Returns:
    
    XML with AppHdr element of the Mx message or null if not found
    
    Since:
    
    7.8.4

Class MxParser

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEADER_LOCALNAME

DOCUMENT_LOCALNAME

Constructor Detail

MxParser

MxParser

MxParser

MxParser

Method Detail

parse

parse

parse

payload

parseBusinessHeader

parseBusinessHeader

parseApplicationHeader

parseApplicationHeader

parseBusinessApplicationHeaderV01

parseBusinessApplicationHeaderV01

detectMessage

analizeMessage

mx

getBICFromDN

stripDocument

stripHeader