com.prowidesoftware.swift.io.parser

Class MxParser

java.lang.Object

com.prowidesoftware.swift.io.parser.MxParser

public class MxParser
extends Object

Basic parser for MX messages.
This parser has two main utilities; 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)
The second utility is to parse the application header extract of the xml into an ApplicationHeader object, mainly used to identify the specific message.
This implementation can be used also as a fast/lightweight parse from where to build richer API to gather business information from the messages' content.

Since:

7.6

Constructor Summary

Constructors

Constructor and Description
MxParser() Deprecated.
MxParser(File file) Construct a parser for a file containing a single MX message
MxParser(InputStream stream) Construct a parser for a stream containing a single MX message
MxParser(String message) Creates the parser initializing its content source from the given string.

Method Summary

Methods

Modifier and Type	Method and Description
MxId	detectMessage() Takes an xml with an MX message and detects the specific message type parsing just the namespace from the Document element.
MxPayload	mx()
MxNode	parse() Non-namespace aware parse. Parses the complete message content into an MXNode tree structure.
MxNode	parse(InputStream stream) Deprecated.
MxNode	parse(Reader reader) Deprecated.
ApplicationHeader	parseApplicationHeader() Parses the application header from the internal message source.
BusinessApplicationHeaderV01	parseBusinessApplicationHeaderV01() Parses the application header from the internal message source.
BusinessHeader	parseBusinessHeader()
MxPayload	payload() Attempt to parse the full payload of an MX message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MxParser

@Deprecated
public MxParser()

Deprecated.

MxParser

public MxParser(File file)
         throws IOException

Construct a parser for a file containing a single MX message

Parameters:

file - the file containing a single unit of a message

Throws:

IOException - if an error occurs during the read of the file

Since:

7.7

MxParser

public MxParser(InputStream stream)
         throws IOException

Construct a parser for a stream containing a single MX message

Parameters:

file - the file containing a single unit of a message

stream - non null stream containing a single unit of message

Throws:

IOException

MxParser

public MxParser(String message)

Creates the parser initializing its content source from the given string.

Since:

7.7

Method Detail

parse

@Deprecated
public MxNode parse(InputStream stream)

Deprecated.

Initializes the parser with the given stream, and returns its parsed content.

Since:

7.6

parse

@Deprecated
public MxNode parse(Reader reader)
             throws IOException

Deprecated.

Initializes the parser with the given reader, and returns its parsed content.

Throws:

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

public MxPayload payload()

Attempt to parse the full payload of an MX message.

Returns:

the payload object with the result of the best effort parse

Since:

7.7

parseBusinessHeader

public BusinessHeader parseBusinessHeader()

parseApplicationHeader

public ApplicationHeader parseApplicationHeader()

Parses the application header 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

parseBusinessApplicationHeaderV01

public BusinessApplicationHeaderV01 parseBusinessApplicationHeaderV01()

Parses the application header 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

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:

Returns:

id with the detected MX message type or null if it cannot be determined.

Since:

7.7

mx

public MxPayload mx()