com.prowidesoftware.swift.io.parser

Class MxParser

java.lang.Object

com.prowidesoftware.swift.io.parser.MxParser

Deprecated.

see deprecation notes on each method

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public class MxParser
extends java.lang.Object

This class is currently deprecated. The API provided is no longer useful or has been replaced by similar or moved methods in: AbstractMX, AppHdr, AppHdrParser, MxNode or MxParseUtils

Since:

7.6

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MxParser.MxStructureInfo Deprecated. the AbstractMX.parse(String) can be used to parse any unknown message. If you just want to detect the message type you can also use the MxParseUtils.identifyMessage(String)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOCUMENT_LOCALNAME Deprecated. use AbstractMX.DOCUMENT_LOCALNAME instead
static java.lang.String	HEADER_LOCALNAME Deprecated. use AppHdr.HEADER_LOCALNAME instead

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MxParser.MxStructureInfo	analizeMessage() Deprecated. use analyzeMessage() instead
MxParser.MxStructureInfo	analyzeMessage() Deprecated. the AbstractMX.parse(String) can be used to parse any unknown message. If you just want to detect the message type you can also use the MxParseUtils.identifyMessage(String)
MxId	detectMessage() Deprecated. use MxParseUtils.identifyMessage(String) instead
static java.lang.String	getBICFromDN(java.lang.String dn) Deprecated. use MxParseUtils.getBICFromDN(String) instead
MxNode	parse() Deprecated. use MxNode.parse(String) instead
AppHdr	parseAppHdr() Deprecated. use AppHdrParser.parse(String) instead
static AppHdr	parseAppHdr(org.w3c.dom.Element e) Deprecated. use AppHdrParser.parse(Element) instead
com.prowidesoftware.swift.model.mx.dic.ApplicationHeader	parseApplicationHeader() Deprecated. use LegacyAppHdr.parse(String) instead
static com.prowidesoftware.swift.model.mx.dic.ApplicationHeader	parseApplicationHeader(MxNode tree) Deprecated. use LegacyAppHdr.parse(String) instead
com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01	parseBusinessApplicationHeaderV01() Deprecated. use BusinessAppHdrV01.parse(String) instead
static com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01	parseBusinessApplicationHeaderV01(MxNode tree) Deprecated. use BusinessAppHdrV01.parse(String) instead
BusinessHeader	parseBusinessHeader() Deprecated. use AppHdrParser.parse(String) instead
static BusinessHeader	parseBusinessHeader(org.w3c.dom.Element e) Deprecated. use AppHdrParser.parse(Element) instead
java.lang.String	stripDocument() Deprecated. parse the message using AbstractMX.parse(String) instead, and then use any of the document serializer AbstractMX.document() methods
java.lang.String	stripHeader() Deprecated. parse the message using AbstractMX.parse(String) instead, and then use any of the header serializer AbstractMX.header() methods

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_LOCALNAME

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static final java.lang.String HEADER_LOCALNAME

Deprecated. use AppHdr.HEADER_LOCALNAME instead

See Also:

Constant Field Values

DOCUMENT_LOCALNAME

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static final java.lang.String DOCUMENT_LOCALNAME

Deprecated. use AbstractMX.DOCUMENT_LOCALNAME instead

Since:

7.8.4

See Also:

Constant Field Values

Constructor Detail

MxParser

public MxParser(java.io.File file)
         throws java.io.IOException

Deprecated.

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

Deprecated.

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)

Deprecated.

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

Since:

7.7

Method Detail

parseBusinessHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static BusinessHeader parseBusinessHeader(org.w3c.dom.Element e)

Deprecated. use AppHdrParser.parse(Element) instead

parseAppHdr

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static AppHdr parseAppHdr(org.w3c.dom.Element e)

Deprecated. use AppHdrParser.parse(Element) instead

Since:

9.0.1

parseApplicationHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static com.prowidesoftware.swift.model.mx.dic.ApplicationHeader parseApplicationHeader(MxNode tree)

Deprecated. use LegacyAppHdr.parse(String) instead

parseBusinessApplicationHeaderV01

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01 parseBusinessApplicationHeaderV01(MxNode tree)

Deprecated. use BusinessAppHdrV01.parse(String) instead

getBICFromDN

@ProwideDeprecated(phase2=SRU2021)
 @Deprecated
public static java.lang.String getBICFromDN(java.lang.String dn)

Deprecated. use MxParseUtils.getBICFromDN(String) instead

parse

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public MxNode parse()

Deprecated. use MxNode.parse(String) instead

parseBusinessHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public BusinessHeader parseBusinessHeader()

Deprecated. use AppHdrParser.parse(String) instead

parseAppHdr

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public AppHdr parseAppHdr()

Deprecated. use AppHdrParser.parse(String) instead

Returns:

parsed header or null if the content cannot be parsed or the header is not present in the XML

Since:

9.0.1

parseApplicationHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public com.prowidesoftware.swift.model.mx.dic.ApplicationHeader parseApplicationHeader()

Deprecated. use LegacyAppHdr.parse(String) instead

parseBusinessApplicationHeaderV01

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01 parseBusinessApplicationHeaderV01()

Deprecated. use BusinessAppHdrV01.parse(String) instead

detectMessage

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public MxId detectMessage()

Deprecated. use MxParseUtils.identifyMessage(String) instead

Returns:

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

Since:

7.7

analizeMessage

@Deprecated
 @ProwideDeprecated(phase4=SRU2021)
public MxParser.MxStructureInfo analizeMessage()

Deprecated. use analyzeMessage() instead

Since:

7.8.4

analyzeMessage

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public MxParser.MxStructureInfo analyzeMessage()

Deprecated. the AbstractMX.parse(String) can be used to parse any unknown message. If you just want to detect the message type you can also use the MxParseUtils.identifyMessage(String)

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.10.3

stripDocument

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public java.lang.String stripDocument()

Deprecated. parse the message using AbstractMX.parse(String) instead, and then use any of the document serializer AbstractMX.document() methods

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 analyzeMessage(). The XML is not converted into DOM on purpose because we want to strip the content event when the XML is not totally well-formed. <

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

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public java.lang.String stripHeader()

Deprecated. parse the message using AbstractMX.parse(String) instead, and then use any of the header serializer AbstractMX.header() methods

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 analyzeMessage(). 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