Create a new Mule Project with Mule Server 3.6.0 EE as runtime:

Locate the AS2 Connector on the right hand-side palette:

Drag the connector over to the canvas:

The connector’s operations leverage the HTTP transport to receive and send AS2 messages. Both endpoint-based and operation-based versions of the HTTP transport are supported since version 2.2.0.

The connector requires an AS2 Connector Configuration. To create a connector configuration, you must first create either a legacy global HTTP endpoint or a HTTP Listener Configuration for receiving messages. Regardless of the HTTP implementation of your choice, you need then to bind the connector configuration to that endpoint.

Steps 5 to 10 depict the creation and association of a legacy (deprecated) HTTP endpoint.

For the current HTTP transport implementation usage jump to Step 11.

Click on the Global Elements tab and create an HTTP endpoint:

Give the HTTP endpoint a more descriptive name like “receive-as2-http-endpoint”. Click on the Connector Configuration add symbol to bring up the HTTP connector configuration dialog:

Give the HTTP connector a more descriptive name like “as2-http-connector” and press OK to go back to the global HTTP endpoint dialog box:

Press OK to close the global HTTP endpoint dialog box:

In this step, you will make an AS2 connector configuration and bind it to the global HTTP endpoint. Create an AS2 Connector Configuration from the Global Elements view:

Type “receive-as2-http-endpoint” in the attribute Global HTTP Endpoint Reference to bind the AS2 connector to the previously created global HTTP endpoint. Press OK.

After completing the previous steps, you should have the following in the Global Elements view:

(if you’ve chosen the legacy HTTP endpoint implementation, skip to Step 14)

Click on the Global Elements tab and create an HTTP Listener Configuration:

Give the HTTP Listener Configuration a more descriptive name like “receive-as2-http-endpoint”.

Press OK to close the global HTTP endpoint dialog box.

In this step, you will make an AS2 connector configuration and bind it to the global HTTP endpoint. Create an AS2 Connector Configuration from the Global Elements view:

Type “receive-as2-http-endpoint” in the attribute Global HTTP Endpoint Reference to bind the AS2 connector to the previously created global HTTP endpoint. Press OK.

Back to the Message Flow view, on the AS2 message source, select “AS2” from the Connector Configuration drop-down list and select “Receive” from the Operation drop-down list:

The connector’s Key Store Path1 attribute must be configured in either of the following scenarios:

For scenario 1, the key store has to contain the certificate used by the AS2 connector to verify the request’s authenticity. Scenario 2 and 3 require the key store to have a dual-purpose public/private key pair that the connector uses to decrypt the request and sign the receipt. The key store entry alias name for the certificate is required to match the AS2-From field received in the request’s headers. Similarly, the key store entry alias name for the public/private key pair is required to match the AS2-To field received in the request’s headers. The attribute Key Store Password must be set if the key store is protected by a password.

For the sake of keeping the example simple, no key store is set so no security is provided by the connector.

Add a File outbound endpoint to save the sender’s AS2 message content. Drag a File outbound endpoint from the palette next to the AS2 Connector. Set the Path attribute to “inbox” and Output Pattern to “data.txt”:

Finally, run the example as a Mule application:

The connector will save the content of valid AS2 messages in the file “data.txt” inside the project root directory “inbox”.

Create a new Mule Project with Mule Server 3.6.0 EE as runtime:

Drag a File inbound endpoint to the canvas to create a message source for a flow. Set the Path attribute to “outbox”:

Locate the AS2 Connector on the right hand-side palette:

Drag the connector over to the canvas next to the File message source:

The connector’s operations leverage the HTTP transport to receive and send AS2 messages. Both legacy and current versions of the HTTP transport are supported since version 2.2.0.

The connector requires an AS2 Connector Configuration. To create a connector configuration, you must first create either a legacy global HTTP endpoint or a HTTP Request Configuration for sending messages. Regardless of the HTTP implementation of your choice, you need then to bind the connector configuration to that endpoint.

Steps 6 to 10 depict the creation and association of a legacy (deprecated) HTTP endpoint.

For the current HTTP transport implementation usage jump to Step 11.

Click on the Global Elements tab and create an HTTP endpoint:

Give the HTTP endpoint a more descriptive name like “send-as2-http-endpoint”. Set the host, port and path attributes to point to an AS2 receiver. Click on the Connector Configuration add symbol to bring up the HTTP connector configuration dialog:

Give the HTTP connector a more descriptive name like “as2-http-connector” and press OK to go back to the global HTTP endpoint dialog box:

Press OK to close the global HTTP endpoint dialog box:

In this step, you will make an AS2 connector configuration and bind it to the global HTTP endpoint. From the Global Elements view, create an AS2 Connector Configuration:

Type “send-as2-http-endpoint” in the attribute Global HTTP Endpoint Reference to bind the AS2 connector to the previously created global HTTP endpoint. Press OK.

After completing the previous steps, you should have the following in the Global Elements view:

(if you’ve chosen the legacy HTTP endpoint implementation, skip to Step 14)

Click on the Global Elements tab and create an HTTP Listener Configuration:

Give the HTTP Listener Configuration a more descriptive name like “send-as2-http-endpoint”. Set the host, port and basePath attributes to point to an AS2 receiver.

Press OK to close the global HTTP endpoint dialog box.

In this step, you will make an AS2 connector configuration and bind it to the global HTTP endpoint. From the Global Elements view, create an AS2 Connector Configuration:

Type “send-as2-http-endpoint” in the attribute Global HTTP Endpoint Reference to bind the AS2 connector to the previously created global HTTP endpoint. Press OK.

Back to the Message Flow view, on the AS2 processor, select “AS2” from the Connector Configuration drop-down list and select “Send” from the Operation drop-down list:

Populate the AS2-From and AS2-To attributes. The AS2-To identifier is typically provided out-of-band by the AS2 receiver.

The connector’s Key Store Path1 attribute must be configured in either of the following scenarios:

Scenario 1 and 2 require the key store to have a dual-purpose public/private key pair that the connector uses to encrypt and sign the request. For scenario 3, the key store has to contain the certificate used by the AS2 connector to verify the receipt’s authenticity. The key store entry alias name for the public/private key pair is required to match the value set in the AS2 From attribute. Similarly, the key store entry alias name for the certificate is required to match the value set in the AS2 To attribute. The attribute Key Store Password must be set if the key store is protected by a password.

For the sake of keeping the example simple, no key store is set so no security is provided by the connector.

Viewing the receipt returned by the AS2 receiver is optional but useful for testing. Append to the flow a Byte Array to String transformer followed by a Logger processor to print the receipt’s content to console.

Note that the Logger in the screenshot has its Message attribute set to "#[payload]"

Finally, run the example as a Mule application:

Drop a file in the "outbox" directory to send it to the receiver over AS2. If you have followed step 14, you should see the receiver’s receipt in the console.

1: The key store must be in JKS format. A cross-platform tool that can help you with the setting up of JKS key stores is KeyStore Explorer. CloudHub deployments must have key stores located within the Mule application Java classpath (e.g., src/main/resources). Furthermore, the key store path attribute has to be relative to the classpath. For instance, if the key store is located at src/main/resources/key-stores/my-key-store.jks, then Key Store Path is set to key-stores/my-key-store.jks.