camel-box-kafka-connector source configuration

When using camel-box-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-box-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.box.CamelBoxSourceConnector

The camel-box source connector supports 40 options, which are listed below.

Name	Description	Default	Required	Priority
camel.source.path.apiName	What kind of operation to perform One of: [COLLABORATIONS] [COMMENTS] [EVENT_LOGS] [FILES] [FOLDERS] [GROUPS] [EVENTS] [SEARCH] [TASKS] [USERS]	null	true	HIGH
camel.source.path.methodName	What sub operation to use for the selected operation	null	true	HIGH
camel.source.endpoint.clientId	Box application client ID	null	false	MEDIUM
camel.source.endpoint.enterpriseId	The enterprise ID to use for an App Enterprise.	null	false	MEDIUM
camel.source.endpoint.inBody	Sets the name of a parameter to be passed in the exchange In Body	null	false	MEDIUM
camel.source.endpoint.userId	The user ID to use for an App User.	null	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	false	MEDIUM
camel.source.endpoint.exchangePattern	Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]	null	false	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	false	MEDIUM
camel.source.endpoint.httpParams	Custom HTTP params for settings like proxy host	null	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	false	MEDIUM
camel.source.endpoint.authenticationType	The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens	"APP_USER_AUTHENTICATION"	false	MEDIUM
camel.source.endpoint.accessTokenCache	Custom Access Token Cache for storing and retrieving access tokens.	null	false	MEDIUM
camel.source.endpoint.clientSecret	Box application client secret	null	false	MEDIUM
camel.source.endpoint.encryptionAlgorithm	The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 One of: [RSA_SHA_256] [RSA_SHA_384] [RSA_SHA_512]	"RSA_SHA_256"	false	MEDIUM
camel.source.endpoint.maxCacheEntries	The maximum number of access tokens in cache.	100	false	MEDIUM
camel.source.endpoint.privateKeyFile	The private key for generating the JWT signature.	null	false	MEDIUM
camel.source.endpoint.privateKeyPassword	The password for the private key.	null	false	MEDIUM
camel.source.endpoint.publicKeyId	The ID for public key for validating the JWT signature.	null	false	MEDIUM
camel.source.endpoint.sslContextParameters	To configure security using SSLContextParameters.	null	false	MEDIUM
camel.source.endpoint.userName	Box user name, MUST be provided	null	false	MEDIUM
camel.source.endpoint.userPassword	Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call	null	false	MEDIUM
camel.component.box.clientId	Box application client ID	null	false	MEDIUM
camel.component.box.configuration	To use the shared configuration	null	false	MEDIUM
camel.component.box.enterpriseId	The enterprise ID to use for an App Enterprise.	null	false	MEDIUM
camel.component.box.userId	The user ID to use for an App User.	null	false	MEDIUM
camel.component.box.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	false	MEDIUM
camel.component.box.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.box.httpParams	Custom HTTP params for settings like proxy host	null	false	MEDIUM
camel.component.box.authenticationType	The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens	"APP_USER_AUTHENTICATION"	false	MEDIUM
camel.component.box.accessTokenCache	Custom Access Token Cache for storing and retrieving access tokens.	null	false	MEDIUM
camel.component.box.clientSecret	Box application client secret	null	false	MEDIUM
camel.component.box.encryptionAlgorithm	The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 One of: [RSA_SHA_256] [RSA_SHA_384] [RSA_SHA_512]	"RSA_SHA_256"	false	MEDIUM
camel.component.box.maxCacheEntries	The maximum number of access tokens in cache.	100	false	MEDIUM
camel.component.box.privateKeyFile	The private key for generating the JWT signature.	null	false	MEDIUM
camel.component.box.privateKeyPassword	The password for the private key.	null	false	MEDIUM
camel.component.box.publicKeyId	The ID for public key for validating the JWT signature.	null	false	MEDIUM
camel.component.box.sslContextParameters	To configure security using SSLContextParameters.	null	false	MEDIUM
camel.component.box.userName	Box user name, MUST be provided	null	false	MEDIUM
camel.component.box.userPassword	Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.source.path.apiName

What kind of operation to perform One of: [COLLABORATIONS] [COMMENTS] [EVENT_LOGS] [FILES] [FOLDERS] [GROUPS] [EVENTS] [SEARCH] [TASKS] [USERS]

null

true

HIGH

camel.source.path.methodName

What sub operation to use for the selected operation

null

true

HIGH

camel.source.endpoint.clientId

Box application client ID

null

false

MEDIUM

camel.source.endpoint.enterpriseId

The enterprise ID to use for an App Enterprise.

null

false

MEDIUM

camel.source.endpoint.inBody

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

null

false

MEDIUM

camel.source.endpoint.userId

The user ID to use for an App User.

null

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

false

MEDIUM

camel.source.endpoint.exchangePattern

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

null

false

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.httpParams

Custom HTTP params for settings like proxy host

null

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.authenticationType

The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens

"APP_USER_AUTHENTICATION"

false

MEDIUM

camel.source.endpoint.accessTokenCache

Custom Access Token Cache for storing and retrieving access tokens.

null

false

MEDIUM

camel.source.endpoint.clientSecret

Box application client secret

null

false

MEDIUM

camel.source.endpoint.encryptionAlgorithm

The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 One of: [RSA_SHA_256] [RSA_SHA_384] [RSA_SHA_512]

"RSA_SHA_256"

false

MEDIUM

camel.source.endpoint.maxCacheEntries

The maximum number of access tokens in cache.

100

false

MEDIUM

camel.source.endpoint.privateKeyFile

The private key for generating the JWT signature.

null

false

MEDIUM

camel.source.endpoint.privateKeyPassword

The password for the private key.

null

false

MEDIUM

camel.source.endpoint.publicKeyId

The ID for public key for validating the JWT signature.

null

false

MEDIUM

camel.source.endpoint.sslContextParameters

To configure security using SSLContextParameters.

null

false

MEDIUM

camel.source.endpoint.userName

Box user name, MUST be provided

null

false

MEDIUM

camel.source.endpoint.userPassword

Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call

null

false

MEDIUM

camel.component.box.clientId

Box application client ID

null

false

MEDIUM

camel.component.box.configuration

To use the shared configuration

null

false

MEDIUM

camel.component.box.enterpriseId

The enterprise ID to use for an App Enterprise.

null

false

MEDIUM

camel.component.box.userId

The user ID to use for an App User.

null

false

MEDIUM

camel.component.box.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.box.basicPropertyBinding

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

false

LOW

camel.component.box.httpParams

Custom HTTP params for settings like proxy host

null

false

MEDIUM

camel.component.box.authenticationType

The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens

"APP_USER_AUTHENTICATION"

false

MEDIUM

camel.component.box.accessTokenCache

Custom Access Token Cache for storing and retrieving access tokens.

null

false

MEDIUM

camel.component.box.clientSecret

Box application client secret

null

false

MEDIUM

camel.component.box.encryptionAlgorithm

The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 One of: [RSA_SHA_256] [RSA_SHA_384] [RSA_SHA_512]

"RSA_SHA_256"

false

MEDIUM

camel.component.box.maxCacheEntries

The maximum number of access tokens in cache.

100

false

MEDIUM

camel.component.box.privateKeyFile

The private key for generating the JWT signature.

null

false

MEDIUM

camel.component.box.privateKeyPassword

The password for the private key.

null

false

MEDIUM

camel.component.box.publicKeyId

The ID for public key for validating the JWT signature.

null

false

MEDIUM

camel.component.box.sslContextParameters

To configure security using SSLContextParameters.

null

false

MEDIUM

camel.component.box.userName

Box user name, MUST be provided

null

false

MEDIUM

camel.component.box.userPassword

Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call

null

false

MEDIUM

The camel-box sink connector has no converters out of the box.

The camel-box sink connector has no transforms out of the box.

The camel-box sink connector has no aggregation strategies out of the box.