AS2 Connector
Properties Configuration Settings
The AS2 Component adds AS2 send and receive capabilities to MuleSoft.
Remarks
The AS2 Connector adds AS2 send and receive capabilities to your Mule Project. Built on top of the Drummond/eBusinessReady Certified EDI Integrator / AS2 Engine, the connector allows you to easily incorporate secure EDI (EDI-INT) exchange into your current e-Business process architecture.
AS2 Receive Connector
The AS2 Receive Connector requires another entity to listen for incoming HTTP requests and to send responses back to the client. An HTTP Listener may be used in conjunction with the AS2 Receive Connector to create a fully-functional AS2 server.
In order to use the AS2 Receive Connector, you must set the TradingPartner and ReceivingPartner properties. Optionally set the ReceiveMode property to control whether the connector is configured to process AS2 messages or verify MDN receipts.
By default, the connector sets the required MessageSecurity on incoming AS2 requests to the highest level. If your messages require security, you must set an EncryptionCert and/or SignerCert. It is also recommended that you set an MDNSigningCert in order to provide non-repudiation for your AS2 response.
The connector will populate ResponseHeaders and ResponseBody after processing the request.
HTTP Listener Configuration
In a typical scenario a HTTP listener is used to receive the original request and send the response because the connector does not have a webserver of its own. The connector will process the request and generate the response, but will rely on the HTTP Listener to relay the response back to the client. In order to configure the HTTP Listener to relay the response to the client, follow the below steps.
In the Mule HTTP Listener's Responses section set the Body to #[attributes.ResponseBody]. Then, add a new header with value 'Content-Type' and value attributes.ResponseHeaders.'Content-Type'.
The corresponding Configuration XML may look like:
<http:response > <http:body ><![CDATA[#[attributes.ResponseBody]]]></http:body> <http:headers ><![CDATA[#[output applicaton/java --- { "Content-Type" : attributes.ResponseHeaders.'Content-Type' }]]]></http:headers> </http:response>
AS2 Send Connector
The AS2 Send Connector adds a complete AS2 client within your Mule Project. In order to use it, you must set a minimum of three required properties: AS2To, AS2From and URL. It is also recommended that you set MDNTo, RecipientCert, ReceiptSignerCert, and SigningCert in order to make use of security, reliability, and non-repudiation.
The AS2 Send Connector has support for SSL transport layer security. This may be enabled by setting the SSLCert and SSLAcceptServerCert to appropriate values.
Certification and Interoperability
The AS2 Connector for Mule Project has been built on top of the EDI Integrator / AS2 Engine which has successfully completed the latest Drummond/eBusinessReady Certified program for AS2 interoperability. The product has undergone rigorous compliance testing and QA, demonstrating successful interoperability with all other DGI (UCC) AS2 certified products.
The eBusinessReady program provides neutral third party testing of solutions for interoperability and compliance. eBusinessReady is a joint partnership of the UCC (Uniform Code Council, Inc) and DGI (Drummond Group, Inc).
Receiver Property List
The following is the full list of the properties of the receiver connector with short descriptions. Click on the links for further details.
AS2From | The identity of the sending system. |
AS2MessageId | The Id of the message. |
AS2RequestEDIType | The MIME type of the data. |
AS2RequestFrom | The identity of the sending system. |
AS2RequestLogFile | The file used to log AS2 request information. |
AS2RequestScanResult | The result of parsing the request. |
AS2RequestSubject | The subject of the received message. |
AS2RequestTo | The identity of the receiving system. |
AS2To | The identity of the receiving system. |
EncryptionCert | The digital id to be used for decryption. |
Firewall | A set of properties related to firewall access. |
HTTPProxy | A set of properties related to proxy access. |
IncomingDirectory | The directory to be used to store incoming messages. |
LogDirectory | The path to a directory for logging. |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during component execution. |
LogType | How information gets logged during component execution. |
MDNDisposition | The Disposition header in the MDN receipt. |
MDNMICAlgorithm | The algorithm used to sign the outgoing MDN. |
MDNMICValue | The Message Integrity Check(s) (one-way hash) of the EDI message. |
MDNReceipt | The MDN-based receipt generated by the component. |
MDNReceiptDeliveryOption | A URL indicating how the receipt is to be delivered. |
MDNReceiptHeaders | The AS2 headers returned with the receipt. |
MDNReceiptMessage | The textual message included in the MDN. |
MDNReceiptMessageId | The Id of the MDN message. |
MDNSignatureStatus | The validity of the signature in the MDN receipt. |
MDNSigningCert | The digital id to be used to sign the MDN (optional). |
MessageSecurity | Required security level for incoming messages. |
Other | Defines a set of configuration settings to be used by the component. |
ReceiptHeaders | The AS2 headers that are returned with the receipt. |
ReceiptMessage | The textual message that is included in the receipt. |
ReceiptSigningProtocol | The protocol used to sign the outgoing MDN receipt. |
ReceivedFileName | The name of the file received by the AS2 component. |
ReceiveMode | Controls whether the component is configured to process AS2 messages or MDN receipts. |
ReceivingPartner | The identity of AS2 receiving entity. |
RequestHeaders | The headers included in the AS2 request. |
ResponseBody | The response body to be sent to the client. |
ResponseHeaders | A collection of response headers. |
RolloverSignerCert | The rollover decryption and receipt signing certificate. |
RuntimeLicense | Specifies the component runtime license key. |
SignerCert | The signing certificate of the trading partner. |
SSLAcceptServerCert | For sending HTTPS requests, a server certificate to unconditionally accept. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
Timeout | A timeout for the component. |
TradingPartner | The trading partner that will be communicating with this receive location. |
Sender Property List
The following is the full list of the properties of the sender connector with short descriptions. Click on the links for further details.
AS2From | The identity of the sending system. |
AS2MessageId | The Id of the message. |
AS2To | The identity of the receiving system. |
CompressionFormat | The compression format (if any) to use. |
EDIFileName | The name to be used in the Content-Disposition MIME header of the outbound request. |
EDIType | The MIME type of the data. |
EncryptionAlgorithm | The algorithm, if any, used to encrypt the EDI data. |
ErrorCode | TBD. |
ErrorMessage | TBD. |
Firewall | A set of properties related to firewall access. |
HTTPPassword | A password if authentication is to be used. |
HTTPProxy | A set of properties related to proxy access. |
HTTPUser | A user name if authentication is to be used. |
LogDirectory | The path to a directory for logging. |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during component execution. |
LogType | How information gets logged during component execution. |
MDNMICValue | The Message Integrity Check(s) (one-way hash) of the EDI message. |
MDNOptions | Used to indicate the options requested for the MDN receipt. |
MDNReceiptAS2From | The identity of the sending system. |
MDNReceiptAS2To | The identity of the receiving system. |
MDNReceiptHeaders | The AS2 headers returned with the receipt. |
MDNReceiptLogFile | The file used for logging MDN information. |
MDNReceiptMessage | The textual message included in the MDN. |
MDNReceiptMessageId | The Id of the MDN message. |
MDNTo | Used to indicate that a message disposition notification is requested. |
Other | Defines a set of configuration settings to be used by the component. |
ReceiptHeaders | The AS2 headers that are returned with the receipt. |
ReceiptMDN | The MDN generated by the component. |
ReceiptMessage | The textual message that is included in the receipt. |
ReceiptSignerCert | The certificate of the receipt signer. |
RecipientCert | The certificate of the recipient. |
RolloverSigningCert | An additional certificate used to sign the outgoing AS2 request when transitioning certificates. |
RuntimeLicense | Specifies the component runtime license key. |
SigningCert | The certificate used to sign the outgoing AS2 request. |
SSLAcceptServerCert | For sending HTTPS requests, a server certificate to unconditionally accept. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
Timeout | A timeout for the component. |
URL | The URL to post to. |
Configuration Settings
The following is a list of configuration settings for the connector with short descriptions. Click on the links for further details.
AcceptAnySignerCert | Used to accept trust any signing certificate unconditionally. |
AS2Subject | The subject of the message. |
AsyncMDNInfoDir | The location on disk where MDN information is stored. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
ErrorOnNegativeMDN | Whether an exception should be raised when a negative MDN is received. |
ErrorProcessingFlags | Flags controlling how errors affect ProcessRequest. |
ErrorReportingFlags | Flags controlling how errors affect the MDNReceipt. |
From | The email address of the HTTP agent (optional). |
LogDebug | Whether to log debug data. |
MDNDeliveryOption | A URL indicating how the receipt is to be delivered. |
MDNWarning | A warning to appear in the MDN. |
OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used when encrypting a key. |
OAEPParams | The hex encoded OAEP parameters to be used when encrypting a key. |
OAEPRSAHashAlgorithm | The RSA hash algorithm used when encrypting a key. |
OtherHeaders | Other headers as determined by the user. |
SignatureAlgorithm | Signature algorithm to be used in outgoing messages. |
SMTPFrom | The senders address for asynchronous MDN delivery. |
SMTPServer | The SMTP server for asynchronous MDN delivery. |
SMTPSubject | The SMTP message subject for asynchronous MDN delivery. |
UseChunkedEncoding | Whether to chunk outgoing posts. |
UseOAEP | Whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the key with RSA. |
UsePSS | Whether to use RSA-PSS when signing. |
UserAgent | Information about the user agent. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLSecurityFlags | Flags that control certificate verification. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |