camel-as2-kafka-connector source configuration

When using camel-as2-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-as2-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.as2.CamelAs2SourceConnector

The camel-as2 source connector supports 53 options, which are listed below.

Name	Description	Default	Priority
camel.source.path.apiName	What kind of operation to perform One of: [CLIENT] [SERVER]	null	HIGH
camel.source.path.methodName	What sub operation to use for the selected operation	null	HIGH
camel.source.endpoint.as2From	The value of the AS2From header of AS2 message.	null	MEDIUM
camel.source.endpoint.as2MessageStructure	The structure of AS2 Message. One of: PLAIN - No encryption, no signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption, no signature, ENCRYPTED_SIGNED - Encryption, signature One of: [PLAIN] [SIGNED] [ENCRYPTED] [SIGNED_ENCRYPTED] [PLAIN_COMPRESSED] [SIGNED_COMPRESSED] [ENCRYPTED_COMPRESSED] [ENCRYPTED_COMPRESSED_SIGNED]	null	MEDIUM
camel.source.endpoint.as2To	The value of the AS2To header of AS2 message.	null	MEDIUM
camel.source.endpoint.as2Version	The version of the AS2 protocol. One of: [1.0] [1.1]	"1.1"	MEDIUM
camel.source.endpoint.clientFqdn	The Client Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint.	"camel.apache.org"	MEDIUM
camel.source.endpoint.compressionAlgorithm	The algorithm used to compress EDI message. One of: [ZLIB]	null	MEDIUM
camel.source.endpoint.decryptingPrivateKey	The key used to encrypt the EDI message.	null	MEDIUM
camel.source.endpoint.dispositionNotificationTo	The value of the Disposition-Notification-To header. Assigning a value to this parameter requests a message disposition notification (MDN) for the AS2 message.	null	MEDIUM
camel.source.endpoint.ediMessageTransferEncoding	The transfer encoding of EDI message.	null	MEDIUM
camel.source.endpoint.ediMessageType	The content type of EDI message. One of application/edifact, application/edi-x12, application/edi-consent	null	MEDIUM
camel.source.endpoint.encryptingAlgorithm	The algorithm used to encrypt EDI message. One of: [AES128_CBC] [AES192_CBC] [AES256_CBC] [AES128_CCM] [AES192_CCM] [AES256_CCM] [AES128_GCM] [AES192_GCM] [AES256_GCM] [CAMELLIA128_CBC] [CAMELLIA192_CBC] [CAMELLIA256_CBC] [CAST5_CBC] [DES_CBC] [DES_EDE3_CBC] [GOST28147_GCFB] [IDEA_CBC] [RC2_CBC] [RC4] [SEED_CBC]	null	MEDIUM
camel.source.endpoint.encryptingCertificateChain	The chain of certificates used to encrypt EDI message.	null	MEDIUM
camel.source.endpoint.from	The value of the From header of AS2 message.	null	MEDIUM
camel.source.endpoint.inBody	Sets the name of a parameter to be passed in the exchange In Body	null	MEDIUM
camel.source.endpoint.mdnMessageTemplate	The template used to format MDN message	null	MEDIUM
camel.source.endpoint.requestUri	The request URI of EDI message.	"/"	MEDIUM
camel.source.endpoint.server	The value included in the Server message header identifying the AS2 Server.	"Camel AS2 Server Endpoint"	MEDIUM
camel.source.endpoint.serverFqdn	The Server Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint.	"camel.apache.org"	MEDIUM
camel.source.endpoint.serverPortNumber	The port number of server.	null	MEDIUM
camel.source.endpoint.signedReceiptMicAlgorithms	The list of algorithms, in order of preference, requested to generate a message integrity check (MIC) returned in message dispostion notification (MDN)	null	MEDIUM
camel.source.endpoint.signingAlgorithm	The algorithm used to sign EDI message. One of: [SHA3_224WITHRSA] [SHA3_256WITHRSA] [SHA3_384withRSA] [SHA3_512WITHRSA] [MD5WITHRSA] [SHA1WITHRSA] [MD2WITHRSA] [SHA224WITHRSA] [SHA256WITHRSA] [SHA384WITHRSA] [SHA512WITHRSA] [RIPEMD128WITHRSA] [RIPEMD160WITHRSA] [RIPEMD256WITHRSA] [SHA224WITHDSA] [SHA256WITHDSA] [SHA384WITHDSA] [SHA512WITHDSA] [SHA3_224WITHDSA] [SHA3_256WITHDSA] [SHA3_384WITHDSA] [SHA3_512WITHDSA] [SHA1WITHDSA] [SHA3_224WITHECDSA] [SHA3_256WITHECDSA] [SHA3_384WITHECDSA] [SHA3_512WITHECDSA] [SHA1WITHECDSA] [SHA224WITHECDSA] [SHA256WITHECDSA] [SHA384WITHECDSA] [SHA512WITHECDSA] [SHA1WITHPLAIN_ECDSA] [SHA224WITHPLAIN_ECDSA] [SHA256WITHPLAIN_ECDSA] [SHA384WITHPLAIN_ECDSA] [SHA512WITHPLAIN_ECDSA] [RIPEMD160WITHPLAIN_ECDSA] [SHA1WITHRSAANDMGF1] [SHA224WITHRSAANDMGF1] [SHA256WITHRSAANDMGF1] [SHA384WITHRSAANDMGF1] [SHA512WITHRSAANDMGF1] [SHA3_224WITHRSAANDMGF1] [SHA3_256WITHRSAANDMGF1] [SHA3_384WITHRSAANDMGF1] [SHA3_512WITHRSAANDMGF1]	null	MEDIUM
camel.source.endpoint.signingCertificateChain	The chain of certificates used to sign EDI message.	null	MEDIUM
camel.source.endpoint.signingPrivateKey	The key used to sign the EDI message.	null	MEDIUM
camel.source.endpoint.subject	The value of Subject header of AS2 message.	null	MEDIUM
camel.source.endpoint.targetHostname	The host name (IP or DNS name) of target host.	null	MEDIUM
camel.source.endpoint.targetPortNumber	The port number of target host. -1 indicates the scheme default port.	null	MEDIUM
camel.source.endpoint.userAgent	The value included in the User-Agent message header identifying the AS2 user agent.	"Camel AS2 Client Endpoint"	MEDIUM
camel.source.endpoint.bridgeErrorHandler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	MEDIUM
camel.source.endpoint.sendEmptyMessageWhenIdle	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.	false	MEDIUM
camel.source.endpoint.exceptionHandler	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.	null	MEDIUM
camel.source.endpoint.exchangePattern	Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]	null	MEDIUM
camel.source.endpoint.pollStrategy	A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.	null	MEDIUM
camel.source.endpoint.basicPropertyBinding	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	MEDIUM
camel.source.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	MEDIUM
camel.source.endpoint.backoffErrorThreshold	The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.	null	MEDIUM
camel.source.endpoint.backoffIdleThreshold	The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.	null	MEDIUM
camel.source.endpoint.backoffMultiplier	To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.	null	MEDIUM
camel.source.endpoint.delay	Milliseconds before the next poll.	500L	MEDIUM
camel.source.endpoint.greedy	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.	false	MEDIUM
camel.source.endpoint.initialDelay	Milliseconds before the first poll starts.	1000L	MEDIUM
camel.source.endpoint.repeatCount	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.	0L	MEDIUM
camel.source.endpoint.runLoggingLevel	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]	"TRACE"	MEDIUM
camel.source.endpoint.scheduledExecutorService	Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.	null	MEDIUM
camel.source.endpoint.scheduler	To use a cron scheduler from either camel-spring or camel-quartz component One of: [none] [spring] [quartz]	"none"	MEDIUM
camel.source.endpoint.schedulerProperties	To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.	null	MEDIUM
camel.source.endpoint.startScheduler	Whether the scheduler should be auto started.	true	MEDIUM
camel.source.endpoint.timeUnit	Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]	"MILLISECONDS"	MEDIUM
camel.source.endpoint.useFixedDelay	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.	true	MEDIUM
camel.component.as2.configuration	To use the shared configuration	null	MEDIUM
camel.component.as2.bridgeErrorHandler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	MEDIUM
camel.component.as2.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	MEDIUM

Name

Description

Default

Priority

camel.source.path.apiName

What kind of operation to perform One of: [CLIENT] [SERVER]

null

HIGH

camel.source.path.methodName

What sub operation to use for the selected operation

null

HIGH

camel.source.endpoint.as2From

The value of the AS2From header of AS2 message.

null

MEDIUM

camel.source.endpoint.as2MessageStructure

The structure of AS2 Message. One of: PLAIN - No encryption, no signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption, no signature, ENCRYPTED_SIGNED - Encryption, signature One of: [PLAIN] [SIGNED] [ENCRYPTED] [SIGNED_ENCRYPTED] [PLAIN_COMPRESSED] [SIGNED_COMPRESSED] [ENCRYPTED_COMPRESSED] [ENCRYPTED_COMPRESSED_SIGNED]

null

MEDIUM

camel.source.endpoint.as2To

The value of the AS2To header of AS2 message.

null

MEDIUM

camel.source.endpoint.as2Version

The version of the AS2 protocol. One of: [1.0] [1.1]

"1.1"

MEDIUM

camel.source.endpoint.clientFqdn

The Client Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint.

"camel.apache.org"

MEDIUM

camel.source.endpoint.compressionAlgorithm

The algorithm used to compress EDI message. One of: [ZLIB]

null

MEDIUM

camel.source.endpoint.decryptingPrivateKey

The key used to encrypt the EDI message.

null

MEDIUM

camel.source.endpoint.dispositionNotificationTo

The value of the Disposition-Notification-To header. Assigning a value to this parameter requests a message disposition notification (MDN) for the AS2 message.

null

MEDIUM

camel.source.endpoint.ediMessageTransferEncoding

The transfer encoding of EDI message.

null

MEDIUM

camel.source.endpoint.ediMessageType

The content type of EDI message. One of application/edifact, application/edi-x12, application/edi-consent

null

MEDIUM

camel.source.endpoint.encryptingAlgorithm

The algorithm used to encrypt EDI message. One of: [AES128_CBC] [AES192_CBC] [AES256_CBC] [AES128_CCM] [AES192_CCM] [AES256_CCM] [AES128_GCM] [AES192_GCM] [AES256_GCM] [CAMELLIA128_CBC] [CAMELLIA192_CBC] [CAMELLIA256_CBC] [CAST5_CBC] [DES_CBC] [DES_EDE3_CBC] [GOST28147_GCFB] [IDEA_CBC] [RC2_CBC] [RC4] [SEED_CBC]

null

MEDIUM

camel.source.endpoint.encryptingCertificateChain

The chain of certificates used to encrypt EDI message.

null

MEDIUM

camel.source.endpoint.from

The value of the From header of AS2 message.

null

MEDIUM

camel.source.endpoint.inBody

Sets the name of a parameter to be passed in the exchange In Body

null

MEDIUM

camel.source.endpoint.mdnMessageTemplate

The template used to format MDN message

null

MEDIUM

camel.source.endpoint.requestUri

The request URI of EDI message.

"/"

MEDIUM

camel.source.endpoint.server

The value included in the Server message header identifying the AS2 Server.

"Camel AS2 Server Endpoint"

MEDIUM

camel.source.endpoint.serverFqdn

The Server Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint.

"camel.apache.org"

MEDIUM

camel.source.endpoint.serverPortNumber

The port number of server.

null

MEDIUM

camel.source.endpoint.signedReceiptMicAlgorithms

The list of algorithms, in order of preference, requested to generate a message integrity check (MIC) returned in message dispostion notification (MDN)

null

MEDIUM

camel.source.endpoint.signingAlgorithm

The algorithm used to sign EDI message. One of: [SHA3_224WITHRSA] [SHA3_256WITHRSA] [SHA3_384withRSA] [SHA3_512WITHRSA] [MD5WITHRSA] [SHA1WITHRSA] [MD2WITHRSA] [SHA224WITHRSA] [SHA256WITHRSA] [SHA384WITHRSA] [SHA512WITHRSA] [RIPEMD128WITHRSA] [RIPEMD160WITHRSA] [RIPEMD256WITHRSA] [SHA224WITHDSA] [SHA256WITHDSA] [SHA384WITHDSA] [SHA512WITHDSA] [SHA3_224WITHDSA] [SHA3_256WITHDSA] [SHA3_384WITHDSA] [SHA3_512WITHDSA] [SHA1WITHDSA] [SHA3_224WITHECDSA] [SHA3_256WITHECDSA] [SHA3_384WITHECDSA] [SHA3_512WITHECDSA] [SHA1WITHECDSA] [SHA224WITHECDSA] [SHA256WITHECDSA] [SHA384WITHECDSA] [SHA512WITHECDSA] [SHA1WITHPLAIN_ECDSA] [SHA224WITHPLAIN_ECDSA] [SHA256WITHPLAIN_ECDSA] [SHA384WITHPLAIN_ECDSA] [SHA512WITHPLAIN_ECDSA] [RIPEMD160WITHPLAIN_ECDSA] [SHA1WITHRSAANDMGF1] [SHA224WITHRSAANDMGF1] [SHA256WITHRSAANDMGF1] [SHA384WITHRSAANDMGF1] [SHA512WITHRSAANDMGF1] [SHA3_224WITHRSAANDMGF1] [SHA3_256WITHRSAANDMGF1] [SHA3_384WITHRSAANDMGF1] [SHA3_512WITHRSAANDMGF1]

null

MEDIUM

camel.source.endpoint.signingCertificateChain

The chain of certificates used to sign EDI message.

null

MEDIUM

camel.source.endpoint.signingPrivateKey

The key used to sign the EDI message.

null

MEDIUM

camel.source.endpoint.subject

The value of Subject header of AS2 message.

null

MEDIUM

camel.source.endpoint.targetHostname

The host name (IP or DNS name) of target host.

null

MEDIUM

camel.source.endpoint.targetPortNumber

The port number of target host. -1 indicates the scheme default port.

null

MEDIUM

camel.source.endpoint.userAgent

The value included in the User-Agent message header identifying the AS2 user agent.

"Camel AS2 Client Endpoint"

MEDIUM

camel.source.endpoint.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.exceptionHandler

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.

null

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

MEDIUM

camel.source.endpoint.pollStrategy

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.

null

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffMultiplier

To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.

null

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

MEDIUM

camel.source.endpoint.repeatCount

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]

"TRACE"

MEDIUM

camel.source.endpoint.scheduledExecutorService

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

null

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component One of: [none] [spring] [quartz]

"none"

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

null

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]

"MILLISECONDS"

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

MEDIUM

camel.component.as2.configuration

To use the shared configuration

null

MEDIUM

camel.component.as2.bridgeErrorHandler

false

MEDIUM

camel.component.as2.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM