as2 feature

AS2 Feature

Version: 17.07

Supported Since: 17.01

AS2 Feature

AS2 Feature provides a collection of API methods that can be used to process messages according to the AS2 (Applicability Statement 2) specification.

APIs Java Docs

processIncomingAS2Message

Parameters
XMessageContext messageContext

The Message Context containing the AS2 message

AS2Station station

The AS2 station configuration

String partnerId

ID of the AS2 partner

This API will process a new AS2 message received over HTTP/S, parses it and performs necessary AS2 protocol specific processing on it such as issuing of a sync MDN and closure of the HTTP/S transport as per AS2 semantics. This also populates the current message with the attachments for subsequent processing.

processIncomingAsyncMDN

Parameters
XMessageContext messageContext

The Message Context containing the received asynchronous MDN

AS2Station station

The AS2 station configuration

String partnerId

ID of the AS2 partner

Returns
AsyncMDNInfo

This API will return a new org.adroitlogic.x.feature.as2.api.AsyncMDNInfo instance containing the received async MDN information.

This API will process a new asynchronous MDN received for an AS2 message sent out by the UltraESB-X, requesting an asynchronous MDN, and returns information of the processed asynchronous MDN.

processIncomingSyncMDN

Parameters
XMessageContext messageContext

The Message Context containing the received synchronous response message

Returns
SyncResponseInfo

This API will return a new org.adroitlogic.x.feature.as2.api.SyncResponseInfo instance containing the received response information.

This API will process the synchronous response received for a AS2 send operation (i.e. a synchronous MDN or a transport ack or nack) and returns the information received from response.

prepareAS2MessageForSend

Parameters
XMessageContext messageContext

The Message Context containing the information for AS2 message

AS2Station station

The AS2 station configuration

AS2Partner partner

The AS2 partner configuration

This API will create an AS2 message using the current Message and its attachments, and sets the destination URL of the partner.

prepareAsyncMDNForSend

Parameters
XMessageContext messageContext

The Message Context containing the asynchronous MDN message to be sent

This API will prepare the asynchronous MDN message to be sent by populating the payload (i.e. containing the MDN), transport headers and async MDN URL of the partner set as the default destination.

isMDNRequested

Parameters
XMessageContext messageContext

The Message Context containing the AS2 message

Returns
Boolean

This API will return true if a synchronous or an asynchronous MDN is requested by the AS2 message, or false otherwise.

This API will return whether a MDN is requested by a particular AS2 message using the SEND_INFO object in context property. This can be either a synchronous or an asynchronous MDN.

isAsyncMDNRequested

Parameters
XMessageContext messageContext

The Message Context containing the AS2 message

Returns
Boolean

This API will return true if it is safe to send an asynchronous MDN (i.e. an asynchronous MDN is requested and a synchronous MDN is not already sent), or false otherwise.

This API will check whether an asynchronous MDN is requested by a particular AS2 message and a synchronous MDN is not already sent, using the RECEIVE_INFO object in context property.

In this topic
In this topic
Contact Us