AS2 Nonblocking Emit Service (com.ibi.agents.XDNAS2EmitAgent)

Syntax:

com.ibi.agents.XDNAS2EmitAgent

iIT Service Object:

emit: AS2 Nonblocking Emit

http: AS2 Nonblocking Emit

Description:

Emits AS2 messages to a client without interrupting a configured business process. For more information, see the iWay Service Manager Protocol Guide.

Parameters: - Configuration Parameters

Parameter

Description

Destination

URL that is used to post this information.

HTTP Client Provider

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 should be requested, 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

Directory into which synchronous MDNs are stored. Specific file name is optional. Use * in file name to add a timestamp and use # to add a sequential counter.

Content-Type

Specifies the content-type of data to be 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

File name to put in the Content-Disposition header value.

User ID

User ID for Basic Authentication challenges.

Password

Password for Basic Authentication challenges.

Domain

Domain for NTLM authentication challenges. To use NTLM, you must enable connection persistence.

Request Header Namespace

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

Special register namespace from which MIME headers for the outgoing request will be 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

Special register namespace into which HTTP headers for the incoming response will be saved.

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

MDN Header Namespace

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

Special register namespace into which MDN fields will be 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, 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, the HTTP request entity will be compressed using the selected encoding and the Content-Encoding header will be set accordingly.

Replace Connection?

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

Maximum HTTP Client Manager Delay

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

Maximum Request Size

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

Maximum Response Size

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

Try Expect/Continue Handshake?

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

Parameters: - S/MIME

Parameter

Description

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

Provider for the Keystore used to sign and encrypt messages.

S/MIME Truststore Provider

Provider for the Keystore containing the S/MIME Certificate Authorities.

S/MIME Certificate Store Providers

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

JCE Provider for S/MIME Cryptography services.

S/MIME Verification JCE Crypto Provider

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

S/MIME PKIX JCE Provider

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

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

Digest Algorithm

Algorithm to be used for signing.

Encryption Algorithm

Algorithm to be used for encrypting.

Include Certificate Chain

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

  • Complete Certificate Chain
  • No Certificate
  • Signer Certificate only

Enforce KeyUsage Extension

If set to 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, use the CRLs from the CertStores to check whether the signer's certificate has been revoked.

Unrecognized Certs Location

Directory to store unrecognized certificates found in S/MIME messages.

Parameters: - IP Properties

Parameter

Description

IP Properties

Persistence

If checked, ask the server to maintain the connection.

Response Timeout value in seconds

Seconds to wait for a response before signaling an error.

Parameters: - Agent Specific parameters

Parameter

Description

Return

Return from this agent. Select one of the following options from the drop-down list:

  • input
  • status
  • response

Preemitter

Determines whether any preemitter should be avoided. If set to true, preemitters will not run.

Response Wrapper Tag

The tag name with which to wrap the response if the response is non-XML and must be XML.

Response Base64 Encoded

If set to true, Response will be Base64 encoded.

Edges:

The following table lists the available line edges for the AS2 Nonblocking Emit Service (com.ibi.agents.XDNAS2EmitAgent).

Line Edge

Description

OnError

Error

OnSuccess

Success

OnFailure

Failure

OnCustom

  • OnError
  • OnSuccess
  • OnFailure
  • fail_connect
  • fail_info
  • fail_redirection
  • fail_client
  • fail_server
  • fail_operation
  • fail_parse
  • fail_request_too_large
  • fail_response_too_large
  • fail_unsigned