Contact Free trial Login

AS2 Connector Reference 6.0 - Mule 4

Support Category: Premium

The main class of an extension, is the entry point from which configurations, connection providers, operations and sources are going to be declared.

Configurations


Listener Config

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

HTTP Listener

String

Reference to global HTTP Listener definition for our service endpoint used by partner for both action and signal messages.

x

Inbound Request Authentication

Authentication method to use for verifying the incoming HTTP request.

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Security Requirement Level

Enumeration, one of:

  • SIGNED

  • ENCRYPTED

  • SIGNED_ENCRYPTED

The security level required for any AS2 Listener using this configuration for all incoming messages. An error MDN response results if the security requirement is not met.

Partner Config - AS2 Partner Name

String

AS2 system identifier used for AS2-From and AS2-To headers.

x

Partner Config - x509 Alias

String

Certificate and/or private key alias in the keystore. Is required if using signing or encryption.

Partner Config - email

String

Email address used as HTTP 'From' header when sending.

x

Self Config - AS2 Partner Name

String

AS2 system identifier used for AS2-From and AS2-To headers.

x

Self Config - x509 Alias

String

Certificate and/or private key alias in the keystore. Is required if using signing or encryption.

Self Config - email

String

Email address used as HTTP 'From' header when sending.

x

Keystore Password

String

The password of the provided keystore.

x

Keystore Path

String

The Absolute or relative path to the keystore containing certificates and private keys for self (this application) and the partner.

x

Private Key Password

String

If the private key to be used for signing/encryption is password protected, provide that value here.

Connection Types

Async MDN Connection Provider
Parameters
Name Type Description Default Value Required

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

false

Connection Timeout

Number

The timeout for establishing connections to the remote service. This value is qualified by the #connectionTimeoutUnits

30

Connection Timeout Units

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the #connectionTimeout

SECONDS

Max Connections

Number

The maximum number of outbound connections to keep open at the same time. By default the number of connections is unlimited.

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed. The value of this attribute is only used when persistent connections are enabled. This value is qualified by the #connectionIdleTimeoutUnits

30

Connection Idle Timeout Units

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the #connectionIdleTimeoutUnits

MINUTES

Proxy Config

One of:

Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.

TLS Configuration

Tls

Reference to a TLS config element. This will enable HTTPS for this configuration.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, the deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Associated Sources


MDN Listener Config

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

HTTP Listener

String

Reference to global HTTP Listener definition for our service endpoint used by a partner for both action and signal messages.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Partner Config - AS2 Partner Name

String

AS2 system identifier (used for AS2-From and AS2-To headers)

x

Partner Config - x509 Alias

String

Certificate and/or private key alias in keystore (required if using signing or encryption)

Partner Config - email

String

Email address used as HTTP 'From' header when sending

x

Self Config - AS2 Partner Name

String

AS2 system identifier (used for AS2-From and AS2-To headers)

x

Self Config - x509 Alias

String

Certificate and/or private key alias in keystore (required if using signing or encryption)

Self Config - email

String

Email address used as HTTP 'From' header when sending

x

Keystore Password

String

The password of the provided keystore.

x

Keystore Path

String

The Absolute or relative path to the keystore containing certificates and private keys for self(this application) and the partner.

x

Private Key Password

String

If the private key to use for signing/encryption is password protected, provide that value here.

Associated Sources


Send Config

This class represents an extension configuration, values set in this class are commonly used across multiple operations since they represent something core from the extension.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Partner Config - AS2 Partner Name

String

AS2 system identifier (used for AS2-From and AS2-To headers)

x

Partner Config - x509 Alias

String

Certificate and/or private key alias in keystore (required if using signing or encryption)

Partner Config - email

String

Email address used as HTTP 'From' header when sending

x

Self Config - AS2 Partner Name

String

AS2 system identifier (used for AS2-From and AS2-To headers)

x

Self Config - x509 Alias

String

Certificate and/or private key alias in keystore (required if using signing or encryption)

Self Config - email

String

Email address used as HTTP 'From' header when sending

x

Subject

String

Free form text for MIME Subject header

MIC Signature Algorithm

Enumeration, one of:

  • MD5

  • SHA1

  • SHA224

  • SHA256

  • SHA384

  • SHA512

  • UNSIGNED

The algorithm to use when setting the message integrity check value

UNSIGNED

MDN MIC Signature Algorithm

Enumeration, one of:

  • MD5

  • SHA1

  • SHA224

  • SHA256

  • SHA384

  • SHA512

  • UNSIGNED

Request partner to respond with a signed MDN using this algorithm for calculating MIC

UNSIGNED

Encryption Algorithm

Enumeration, one of:

  • DES

  • DES_EDE3

  • RC2

  • AES128_CBC

  • AES192_CBC

  • AES256_CBC

  • AES128_CCM

  • AES192_CCM

  • AES256_CCM

  • AES128_GCM

  • AES192_GCM

  • AES256_GCM

  • AES256_WRAP

  • CAST5

  • UNENCRYPTED

The Algorithm to use when encrypting the message to be sent

UNENCRYPTED

Content Transfer Encoding

Enumeration, one of:

  • BASE64

  • QUOTED_PRINTABLE

  • SEVEN_BIT

  • EIGHT_BIT

  • BINARY

The encoding to use on the content of AS2 message being sent.

BINARY

Request A Receipt

Enumeration, one of:

  • NONE

  • UNSIGNED

  • SIGNED_OPTIONAL

  • SIGNED_REQUIRED

How the connector will behave based on the received receipts.

UNSIGNED

Compression Type

Enumeration, one of:

  • NONE

  • ZLIB

The Compression type to use

NONE

Receipt Delivery URL

String

The Asynchronous MDN delivery address which the mdn will be returned to. This should be the fully formed URL to the Async MDN Listener (AS2 Source Component). Ex: https://example.com/mdn It is only required if "Send With Async MDN" is used.

Keystore Password

String

The password of the provided keystore.

x

Keystore Path

String

The Absolute or relative path to the keystore containing certificates and private keys for self(this application) and the partner.

x

Private Key Password

String

If the private key to use for signing/encryption is password protected, provide that value here.

Connection Types

Outbound Connection Config
Parameters
Name Type Description Default Value Required

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

false

Connection Timeout

Number

The timeout for establishing connections to the remote service. This value is qualified by the #connectionTimeoutUnits

30

Connection Timeout Units

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the #connectionTimeout

SECONDS

Max Connections

Number

The maximum number of outbound connections to keep open at the same time. By default the number of connections is unlimited.

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed. The value of this attribute is only used when persistent connections are enabled. This value is qualified by the #connectionIdleTimeoutUnits

30

Connection Idle Timeout Units

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the #connectionIdleTimeoutUnits

MINUTES

Proxy Config

One of:

Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.

Partner URL

String

Service endpoint URL to the partner.

x

Outbound Request Authentication

HttpRequestAuthentication

Authentication method to use for the HTTP request.

TLS Configuration

Tls

Reference to a TLS config element. This will enable HTTPS for this configuration.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, the deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Operations

Send With Async Mdn

<as2-mule4:send-with-async-mdn>

Performs the send async request using configuration, client and as2RequesterParameters and completes the callback accordingly.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure if repeatable streams should be used and their behavior.

AS2 MIME Type

String

The content type of the Document being sent via AS2 (for example, application/EDI-X12). There are no restrictions on the content-type that are supported.

#[payload.^mimeType]

Content Stream

Binary

The content InputStream to be sent.

#[payload]

Content Description

String

Content MIME part content description

File Name

String

File name of the content stream. If not set, the content will be transferred without a filename.

Request Receipt

Enumeration, one of:

  • NONE

  • UNSIGNED

  • SIGNED_OPTIONAL

  • SIGNED_REQUIRED

How the connector will behave based on the received receipts. If the value set is NONE, no receipt is expected. " "UNSIGNED, expects the returned receipt to be unsigned. SIGNED_OPTIONAL, could have a signed or non-signed receipt." "SIGNED_REQUIRED expects a signed receipt and the application fails if this is not the case.

Require Processed

Boolean

Require Processed response in the MDN to continue the flow (otherwise there is an error)

true

Connection Timeout

Number

An override for the timeout for establishing connections to the remote service as milliseconds. The default of 0 means this value will not be used to override the configuration.

0

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

Throws

  • AS2-MULE4:CONFIGURATION

  • AS2-MULE4:UNAUTHORIZED

  • AS2-MULE4:CONNECTIVITY

  • AS2-MULE4:RETRY_EXHAUSTED

Send With Sync Mdn

<as2-mule4:send-with-sync-mdn>

Performs the send sync request using configuration, client and as2RequesterParameters and completes the callback accordingly.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure if repeatable streams should be used and their associated behavior.

AS2 MIME Type

String

The content type of the Document being sent via AS2 (for example, application/EDI-X12). There are no restrictions on the content-type that are supported.

#[payload.^mimeType]

Content Stream

Binary

The content InputStream to be sent.

#[payload]

Content Description

String

Content MIME part content description

File Name

String

File name of the content stream. If not set, the content will be transferred without filename.

Request Receipt

Enumeration, one of:

  • NONE

  • UNSIGNED

  • SIGNED_OPTIONAL

  • SIGNED_REQUIRED

How the connector will behave based on the received receipts. If the value set is NONE, no receipt is expected. " "UNSIGNED, expects the returned receipt to be unsigned. SIGNED_OPTIONAL, could have a signed or non-signed receipt." "SIGNED_REQUIRED expects a signed receipt and the application fails if this is not the case.

Require Processed

Boolean

Require Processed response in the MDN to continue the flow (otherwise there is an error)

true

Connection Timeout

Number

An override for the timeout for establishing connections to the remote service as milliseconds. The default of 0 means this value will not be used to override the configuration.

0

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

Throws

  • AS2-MULE4:CONFIGURATION

  • AS2-MULE4:MIME_PARSE

  • AS2-MULE4:UNAUTHORIZED

  • AS2-MULE4:CONNECTIVITY

  • AS2-MULE4:SIGNATURE_VERIFY

  • AS2-MULE4:RETRY_EXHAUSTED

Sources

As2 Listener

<as2-mule4:as2-listener>

Represents a listener for AS2 sender requests.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Path

String

This path will be appended to any path set in the listener configuration.

/

Connection Timeout

Number

An override for the timeout for establishing connections to the remote service as milliseconds. The default of 0 means this value will not be used to override the configuration.

0

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster.

Streaming Strategy

Configure if repeatable streams should be used and their associated behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

As2 Mdn Listener

<as2-mule4:as2-mdn-listener>

Represents a MDN listener for AS2 listener requests

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Path

String

This path will be appended to any path set in the listener configuration.

/

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster.

Streaming Strategy

Configure if repeatable streams should be used and their behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Output

Type

Binary

Attributes Type

For Configurations

Types

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

AS2 Listener Attributes

Field Type Description Default Value Required

As2 Message Id

String

AS2 unique message ID from receiver to sender.

x

File Name

String

Received file name.

x

Mime Type

String

Mime type, for example, application/xml and so forth.

x

From Name

String

AS2 Receiver name.

x

Headers

Object

AS2 http headers that elaborate the message format.

x

Mdn Delivery Status

Enumeration, one of:

  • NONE

  • SUCCESS

  • FAILURE

AS2 message validation status

x

To Name

String

AS2 Sender name

x

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message.

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is stored.

AS2 Mdn Attributes

Field Type Description Default Value Required

As2 Message Id

String

AS2 unique message ID from receiver to sender.

x

Disposition Content

Object

AS2 processed MDN report as headers.

x

From Name

String

AS2 Receiver name

x

Headers

Object

AS2 http headers that elaborate the message format.

x

Mdn Alg

Enumeration, one of:

  • MD5

  • SHA1

  • SHA224

  • SHA256

  • SHA384

  • SHA512

  • UNSIGNED

AS2 message integrity check algorithm used

x

Mdn Mic

String

AS2 message integrity check hashcode

x

Mdn Processed

Boolean

AS2 message validation status

false

Original AS2 Message Id

String

AS2 Message ID received

x

Report Text

String

MDN report text

x

To Name

String

AS2 Sender name

x

AS2 Send Attributes

Field Type Description Default Value Required

As2 Mdn Attributes

AS2 returned MDN attribute group

x

As2 Message Id

String

AS2 unique message ID from receiver to sender

x

From Name

String

AS2 receiver name

x

Headers

Object

AS2 http headers that elaborate the message format

x

Msg MIC

String

AS2 message integrity check hashcode

x

Msg MIC Alg

String

AS2 message integrity check algorithm used

x

To Name

String

AS2 sender name

x

Proxy

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

Ntlm Proxy

Field Type Description Default Value Required

Ntlm Domain

String

x

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

AS2 Basic Authentication

Field Type Description Default Value Required

Username

String

Username to authenticate.

x

Password

String

Password of user to authenticate.

x

Success Status Code Validator

Field Type Description Default Value Required

Values

String

x

Failure Status Code Validator

Field Type Description Default Value Required

Values

String

x