2 Home
gitea_admin edited this page 2026-03-11 14:35:02 +00:00

AS2

Transfer data securely and reliably using the AS2 protocol (RFC4130).

Metadata

Property Value
Scheme as2
Support Level Stable
Labels file
Version 4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-as2</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name Type Required Default Description
apiName object What kind of operation to perform
methodName string What sub operation to use for the selected operation
as2From string The value of the AS2From header of AS2 message.
as2MessageStructure object The structure of AS2 Message. One of: PLAIN - No encryption, no signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption, no signature, ENCRYPTED_SIGNED - Encryption, signature
as2To string The value of the AS2To header of AS2 message.
as2Version string 1.1 The version of the AS2 protocol.
asyncMdnPortNumber integer The port number of asynchronous MDN server.
attachedFileName string The name of the attached file
clientFqdn string camel.apache.org The Client Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint.
compressionAlgorithm object The algorithm used to compress EDI message.
dispositionNotificationTo string The value of the Disposition-Notification-To header. Assigning a value to this parameter requests a message disposition notification (MDN) for the AS2 message.
ediMessageTransferEncoding string The transfer encoding of EDI message.
ediMessageType object The content type of EDI message. One of application/edifact, application/edi-x12, application/edi-consent, application/xml
from string The value of the From header of AS2 message.
hostnameVerifier object Set hostname verifier for SSL session.
httpConnectionPoolSize integer 5 The maximum size of the connection pool for http connections (client only)
httpConnectionPoolTtl object 15m The time to live for connections in the connection pool (client only)
httpConnectionTimeout object 5s The timeout of the http connection (client only)
httpSocketTimeout object 5s The timeout of the underlying http socket (client only)
inBody string Sets the name of a parameter to be passed in the exchange In Body
mdnMessageTemplate string The template used to format MDN message
receiptDeliveryOption string The return URL that the message receiver should send an asynchronous MDN to. If not present the receipt is synchronous. (Client only)
requestUri string / The request URI of EDI message.
server string Camel AS2 Server Endpoint The value included in the Server message header identifying the AS2 Server.
serverFqdn string camel.apache.org The Server Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint.
serverPortNumber integer The port number of server.
sslContext object Set SSL context for connection to remote server.
subject string The value of Subject header of AS2 message.
targetHostname string The host name (IP or DNS name) of target host.
targetPortNumber integer 80 The port number of target host. -1 indicates the scheme default port.
userAgent string Camel AS2 Client Endpoint The value included in the User-Agent message header identifying the AS2 user agent.
exceptionHandler object To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
exchangePattern object Sets the exchange pattern when the consumer creates an exchange.
lazyStartProducer boolean false Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
decryptingPrivateKey object The key used to encrypt the EDI message.
encryptingAlgorithm object The algorithm used to encrypt EDI message.
encryptingCertificateChain object The chain of certificates used to encrypt EDI message.
signedReceiptMicAlgorithms array The list of algorithms, in order of preference, requested to generate a message integrity check (MIC) returned in message dispostion notification (MDN)
signingAlgorithm object The algorithm used to sign EDI message.
signingCertificateChain object The chain of certificates used to sign EDI message.
signingPrivateKey object The key used to sign the EDI message.
validateSigningCertificateChain object Certificates to validate the message's signature against. If not supplied, validation will not take place. Server: validates the received message. Client: not yet implemented, should validate the MDN