Non-Blocking AS2 Adapter

General Properties

Authentication Scheme

The scheme to apply when authenticating HTTP requests.

Authentication Realm

If authentication is required, then the name of the configured Realm provider is used.

Request Header Namespace

The special register namespace to which HTTP headers from the incoming requests are saved. The Default Namespace option creates HDR type special registers without a namespace prefix.

Response Header Namespace

The special register namespace from which HTTP headers for the outgoing response are taken. The Default Namespace option sends HDR type registers with no namespace prefix. If None is selected, then no special registers are sent as HTTP headers.

Response Main Part Header Namespace

The special register namespace from which MIME headers for the outgoing response are taken. Provide a prefix to control the response Main BodyPart headers in the presence of attachments. Selecting none means that no special registers are sent as MIME headers.

Excluded Headers

A comma delimited list (case insensitive) of headers that should are not sent with the response, even if they are found in the response header namespace.

HTTP Response Code

An HTTP status code to send when there is no MDN response. This parameter will be evaluated and you can prefix run time functions with a backtick to defer its evaluation until emit time. The usual successful status code is 204, but you can use this parameter to return an HTTP error instead.

Use Safestore?

If set to true, the listener persists incoming messages after handling any protocol-related packaging. Messages are removed from the safestore upon completion of processing or on error if the HTTP response has not yet been returned to the client. Messages remaining in the safestore are processed at listener startup.

Maximum Request Entity Size

When a request is received that is larger than the maximum, the listener will return a 413 HTTP status code and close the connection. Leave this field blank or set a value of zero to have no maximum size limit. The default value is 256KB.

Compress Response

If set to true, the response is compressed with gzip or deflate compression when the client indicates that it can accept compressed transfer encoding.

IP Properties

Port

The TCP port for receipt of HTTP requests.

Local bind address

The local bind address for multi-homed hosts. This parameter value is usually not specified.

Persistence

If set to true, the connection is maintained when the client requests to do so. Otherwise, the connection is closed.

Maximum Connections

This parameter defines the maximum number of simultaneous connections that are allowed. When this threshold is reached, new connections are not accepted until the current connections are closed and the total number of connections is below the limit. Leave this field blank (default) or set a value of zero to have no maximum limit of connections.

Persistence Timeout value in Minutes

The maximum length of time that a connection can persist with no activity.

Set Response NoDelay

If set to true, it disables the Nagle Algorithm on the response. This will result in a faster line turnaround at the expense of an increased number of packets.

Reuse Address

If set to true, when a connection is closed, it immediately makes the address available, bypassing TCP defaults.

Allowable Clients

If supplied, then only messages from this list of fully qualified host names and/or IP addresses are accepted. Accepts comma-separated list or use the FILE() function.

Secure Connection (SSL)

Secure Connection

If set to true, a connection over HTTPS is made.

SSL Context Provider

The named iWay Security provider for SSL Context.

S/MIME

S/MIME Keystore Provider

The name of an iWay KeyStore provider used to decrypt incoming messages and sign receipts.

S/MIME Truststore Provider

The name of an iWay KeyStore provider containing the S/MIME certificate authorities.

S/MIME Certificate Store Providers

The Comma-separated list of Keystore, Directory Certstore or LDAP providers for the certificate stores used to complete signer certificate chains when the signed message contains fewer certificates than needed.

S/MIME JCE Cryptography Provider

The JCE provider for S/MIME cryptography services.

S/MIME PKIX JCE Provider

The JCE provider for S/MIME PKIX services.

S/MIME Decryption Key Alias

The private key alias used to decrypt incoming messages.

S/MIME Decryption Key Password

The password for the Description Private key. If left blank, then the password for accessing the keystore is used.

Enforce KeyUsage Extension

If set to true, verify certificates used for signing allow the digital signature KeyUsage extension, and certificates used for encryption allow the keyEncipherment KeyUsage extension.

Enable Certificate Revocation

If set to true, use the CRLs from the CertStores to check whether the certificate signer has been revoked.

Unrecognized Certs Location

The directory to store unrecognized certificates found in S/MIME messages.

Payload Header Namespace

The special register namespace to which any headers on the extracted body part are stored as HDR registers. If no value is supplied, then the body part headers are saved in the default namespace.

Keep Message Flat

If set to true, the body of the message will be kept as an array of bytes.

MDN (Receipt)

Delayed MDN

If set to true, MDN is delayed until after the request is processed. If specified as delayed, then the MDN must be sent from the process that handles this message. Failure to do so will result in an HTTP204.

MDN Header Namespace

A special register namespace from which MIME headers for the multipart/report entity is taken. This namespace is different than the Response Header Namespace when the MDN is wrapped by an external signature. The default value is mdnhdr.

MDN Field Namespace

A special register namespace where special registers are used to override or add MDN field values. The default value is mdn.

MDN Reporting User Agent

The value of the Reporting-UA field in the MDN. The default value is AS2 Server.

SMTP Host

The host name of the SMTP server. Used for asynchronous MDN through email.

SMTP User

The user name to access SMTP server.

SMTP Password

The password to access SMTP server.

From

The email address used in the From field of the receipt message.

HTTP Client Provider

The HTTP Client provider that manages outgoing connections for asynchronous MSNs.

HTTP Version for Asynchronous MDN

The HTTP Version used to send asynchronous MDNs over HTTP or HTTPS.

Compress Asynchronous MDN

If set to true, asynchronous MDNs over HTTP or HTTPS are compressed using one of the following encoding options:

• deflate {deflate}
• gzip {gzip}
• none {none}

The content-encoding header is set accordingly.

MDN S/MIME Keystore Provider

The provider for the keystore used to sign receipts. Defaults to the value assigned to the S/MIME Keystore Provider.

MDN S/MIME JCE Cryptography provider

The JCE Provider for MDN S/MIME cryptography service. Defaults to the value assigned to the S/MIME JCE Provider.

MDN S/MIME Signature Key Alias

The private key alias used to sign receipts.

MDN S/MIME Signature Key password

The password for signature private key. Defaults to password for accessing the keystore.

Include Certificate Chain

Determines how much of the signer certificate chain is included in a signed receipt. Options include:

• Complete Certificate Chain
• Signer Certificate only
• No Certificates

Other

Optimize Favoring

The selection of memory is useful for large input documents.

Multithreading

The number of documents that can be processed in parallel.

Execution Time Limit

The time limit for document execution (in seconds) before it is terminated.

Default Java File Encoding

The default encoding if incoming message is not self-declaring.

Agent Precedence

The changes in order by which iSM selects agents. This is normally set to Document overrides listener.

Always reply to listener default

If set to true, the default reply definition is used in addition to defined replies.

Error Documents treated normally

If set to true, error documents are processed by any configured pre-emitters.

Listener is Transaction Manager

If set to true, agents run within a local transaction managed by the listener.

Record in Activity Log(s)

If set to true, activity on this channel will be recorded in the activity logs. If set to false, the activity will not be recorded.

...

Header

Each header value from the message.

action

Document

The action field of the post.

as2from

Document

The AS2-From header.

as2to

Document

The AS2-To header.

asxDocType

Document

The payload for an AS2 request or MDN for a receipt.

dispositionFileName

Header

The FileName parameter extracted from the Content-Disposition header.

ip

System

The IP of the sending system.

iwayconfig

System

The current active configuration name.

mdnDisposition

Document

The field extracted from the received MDN.

mdnFinalRecipient

Document

The field extracted from the received MDN.

mdnOriginalMessageId

Document

The field extracted from the received MDN.

mdnOriginalRecipient

Document

The field extracted from the received MDN.

mdnReceivedContentMIC

Document

The field extracted from the received MDN.

mdnReportingUA

Document

The field extracted from the received MDN.

mdnRequested

Document

If set to true, a receipt is requested. If set to false, no receipt is requested.

mdnSent

Document

If set to true, the MDN was already sent. If it is set to false, the MDN was not sent.

msgsize

Document

The physical length of the message payload.

name

System

The assigned name of the master (listener).

protocol

System

The protocol on which the message was received.

requestType

Header

The type of HTTP request (GET, POST, or HEAD).

smime_compressed

Document

If set to true the S/MIME message is compressed. If set to false, the message is not compressed.

smime_encrypted

Document

If set to true the S/MIME message is encrypted. If set to false, the message is not encrypted.

smime_error

Document

The error message that can be used when sending an MDN.

smime_error_diag

Document

The error diagnostic message that can be used when sending an MDN.

smime_mic

Document

The message Identification Code extracted from the S/MIME message

smime_signed

Document

The unsigned, embedded or external depending on the S/MIME packaging that was used.

smime_signer

Document

The Distinguished Name from the Signer certificate.

smime_signer_cn

Document

Common Name (CN) extracted from the Signer certificate.

smime_signing_time

Document

Signing time extracted from the S/MIME signed attributes.

source

Document

The host name of the sending system.

url

Header

The full URL of the HTTP request (GET, POST, or HEAD).

tid

Document

Unique transaction ID.

Configuration Parameters

Destination

The URL that is used to post this information.

HTTP Client Provider

The HTTP client Provider that is used to manage connections for this emitter.

AS2-From

A textual value identifying the sender of data exchange.

AS2-To

A textual value identifying the receiver of data exchange.

Subject

Sets the Subject header.

Request Receipt

Tells the emitter to send a request for receipt in the form of a Message Disposition Notification (MDN).

Asynchronous Receipt URL

If an asynchronous receipt is requested, you must specify the URL to which the receipt should be sent.

Supported values are in the form:

• mailto:user@host- for asynchronous receipt by email
• http://host[:port]/- for asynchronous receipt by HTTP
• https://host[:port]/- for asynchronous receipt by HTTPS

Receipt Destination

The directory to which synchronous MDNs are stored. Specific file names are optional. Use an asterisk (*) in file name to be replaced by timestamp, # by sequential counter.

Content-Type

Specifies the content-type of data that is sent. Select from the drop-down list or provide your own.

Message ID

Set this to control the emitted message ID. Usually this is left blank to let the system generate a unique ID meeting the requirements of RFC 822. Use this only to override the default. This is not recommended.

Content Disposition

The file name to put in the Content-Disposition header value.

User ID

The user ID for Basic Authentication challenges.

Password

The password for Basic Authentication challenges.

Domain

The domain for NTLM authentication challenges. Note that to use NTLM, you must enable connection persistence.

Request Header Namespace

The special register namespace from which HTTP headers for the outgoing request will be taken.

• Default Namespace to send HDR type registers
• Supply a namespace prefix here to indicate which headers to send
• None means that no special registers will be sent as HTTP headers.

Request Main Part Header Namespace

The special register namespace from which MIME headers for the outgoing request are taken. Provide a prefix to control the request Main BodyPart headers in the presence of attachments. Selecting none means that no special registers will be sent as MIME headers.

Response Header Namespace

The special register namespace to which HTTP headers for the incoming response are saved.

• Default Namespace to create special registers with no namespace
• Supply a namespace prefix here to indicate header namespace

MDN Header Namespace

The special register namespace into which MIME headers of the multipart/report entity will be saved. This namespace is ignored if the MDN is unsigned since all headers will be in the Response Header Namespace.

MDN Field Namespace

The special register namespace into which MDN fields are saved.

Excluded Headers

A comma delimited list (case-insensitive) of headers that should not be sent with the request, even if they are found in the request header namespace.

Ask for Compressed Response

If set to true, the requests will set the Accept-Encoding header to indicate that the client can accept a compressed response, as described in RFC-2616. If the response has a compressed content encoding, the client will automatically inflate.

Compress Request

If set to true, the request entities will be compressed using the selected encoding and the content-encoding header are set accordingly.

Replace Connection?

If set to false, the connection will not be returned to the connection pool immediately. The identifier connection will be stored in the httpclient-key special register and the connection can be handled by the HTTP Client Manager agent.

Maximum HTTP Client Manager Delay

The maximum time the HTTP Client Manager can take to deal with a particular connection before it is automatically aborted. The format is [xxh][xxm]xx[s]. The default is 60 seconds.

Maximum Request Size

The maximum size, after compression, of a request entity that is sent with this emitter. 0 means no maximum and blank will default to 256KB.

Maximum Response Size

The maximum size of a response entity that is received by this emitter. 0 means no maximum and blank will default to 256KB.

Try Expect/Continue Handshake?

If checked, the client will send the HTTP Expect: 100-continue header and await HTTP 100 response before sending request body.

S/MIME

Packaging

Tells the emitter how the document should be packaged for transmission. Select from the drop-down list:

• Encrypted
• Signed
• Signed and Encrypted
• Un-encrypted

Compression

Determines when message compression should be applied. Select from the drop-down list:

• Compress After Signature
• Compress Before Signature
• No Compression

S/MIME Keystore Provider

The provider for the Keystore used to sign and encrypt messages.

S/MIME Truststore Provider

The provider for the Keystore containing the S/MIME Certificate Authorities.

S/MIME Certificate Store Providers

A Comma-separated list of Keystore, Directory CertStore, or LDAP providers for the certificate stores, used to complete signer certificate chains when the signed message contains fewer certificates than needed.

S/MIME JCE Cryptography Provider

The JCE Provider for S/MIME Cryptography services.

S/MIME Verification JCE Crypto Provider

The JCE Provider for S/MIME verification cryptography services. Normally left blank. Defaults to S/MIME JCE Provider.

S/MIME PKIX JCE Provider

The JCE Provider for S/MIME PKIX services. If left blank, the default JCE provider for PKIX will be used.

Recipient Public Key Alias

The alias for the recipient public key entry used for encryption.

Signature Key Alias

The alias for the private key entry used for signing.

Signature Key password

The password to access the signature private key. If left blank, the password used to access the Keystore will be used.

Digest Algorithm

The algorithm used for signing.

Encryption Algorithm

The algorithm used for encrypting.

Include Certificate Chain

Determines how much of the signer certificate chain is included in the message. Select from the drop down:

• Complete Certificate Chain
• No Certificate
• Signer Certificate only

Enforce KeyUsage Extension

If on, verify certificates used for signing allow the digital Signature KeyUsage extension, and certificates used for encryption allow the key Encipherment KeyUsage extension.

Enable Certificate Revocation

If set to true, this uses the CRLs from the CertStores to check whether the certificate signer has been revoked.

Unrecognized Certs Location

The directory to store unrecognized certificates found in S/MIME messages.

TCP

Persistence

If checked, ask the server to maintain the connection.

Response Timeout value in seconds

The seconds to wait for response before signaling error.