camel-apache-org/as2
camel-apache-org/as2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update wiki Home page for as2

gitea_admin 2026-10-12 05:34:48 +00:00
parent 6960c9a964
commit 27565bc57e
1 changed files with 70 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
Home.md

@ -1,21 +1,77 @@
# Deploy the Project on CamelX Platform
# AS2
Deploy on CamelX Platform in three steps
Transfer data securely and reliably using the AS2 protocol (RFC4130).
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Scheme | `as2` |
| Support Level | Stable |
| Labels | file |
| Version | 4.20.0 (CEQ 3.36.0) |
## Step 2: Deploy
Click on **"Deploy"**
## Maven Dependency
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
```xml
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-as2</artifactId>
<version>4.20.0 (CEQ 3.36.0)</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `apiName` | enum | ✓ | | 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` | enum | | | 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` | enum | | `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` | enum | | | 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. |
| `ediMessageCharset` | string | | `us-ascii` | The charset of the content type of EDI message. |
| `ediMessageTransferEncoding` | string | | | The transfer encoding of EDI message. |
| `ediMessageType` | enum | | | 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. |
| `httpConnectionPoolSize` | integer | | `5` | The maximum size of the connection pool for http connections (client only) |
| `httpConnectionPoolTtl` | duration | | `15m` | The time to live for connections in the connection pool (client only) |
| `httpConnectionTimeout` | duration | | `5s` | The timeout of the http connection (client only) |
| `httpSocketTimeout` | duration | | `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. |
| `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` | enum | | | Sets the exchange pattern when the consumer creates an exchange. |
| `expectContinue` | boolean | | `false` | Controls whether the Expect: 100-Continue header is included in outbound AS2 messages. When enabled, the client sends the headers first and waits for a 100 Continue response from the server before sending the message body. This can improve efficiency with compatible partners but may cause 3-second delays with servers that don't support the protocol. Default is false for backward compatibility. |
| `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. |
| `accessToken` | string | | | The access token that is used by the client for bearer authentication. |
| `decryptingPrivateKey` | object | | | The key used to encrypt the EDI message. |
| `encryptingAlgorithm` | enum | | | The algorithm used to encrypt EDI message. |
| `encryptingCertificateChain` | object | | | The chain of certificates used to encrypt EDI message. |
| `hostnameVerifier` | object | | | Set hostname verifier for SSL session. |
| `mdnAccessToken` | string | | | The access token that is used by the server when it sends an async MDN. |
| `mdnPassword` | string | | | The password that is used by the server for basic authentication when it sends an async MDN. |
| `mdnUserName` | string | | | The user-name that is used by the server for basic authentication when it sends an async MDN. If options for basic authentication and bearer authentication are both set then basic authentication takes precedence. |
| `password` | string | | | The password that is used by the client for basic authentication. |
| `signedReceiptMicAlgorithms` | string | | | The list of algorithms, in order of preference, requested to generate a message integrity check (MIC) returned in message disposition notification (MDN). Multiple algorithms can be separated by comma. |
| `signingAlgorithm` | enum | | | 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. |
| `sslContext` | object | | | Set SSL context for connection to remote server. |
| `userName` | string | | | The user-name that is used by the client for basic authentication. If options for basic authentication and bearer authentication are both set then basic authentication takes precedence. |
| `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 |