camel-box-kafka-connector source configuration

Connector Description: Upload, download and manage files, folders, groups, collaborations, etc. on box.com.

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 38 options, which are listed below.

Name Description Default Priority

camel.source.path.apiName

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

Enum values:

  • COLLABORATIONS

  • COMMENTS

  • EVENT_LOGS

  • FILES

  • FOLDERS

  • GROUPS

  • EVENTS

  • SEARCH

  • TASKS

  • USERS

HIGH

camel.source.path.methodName

Required What sub operation to use for the selected operation.

HIGH

camel.source.endpoint.clientId

Box application client ID.

MEDIUM

camel.source.endpoint.enterpriseId

The enterprise ID to use for an App Enterprise.

MEDIUM

camel.source.endpoint.inBody

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

MEDIUM

camel.source.endpoint.userId

The user ID to use for an App User.

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.

MEDIUM

camel.source.endpoint.exchangePattern

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

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.httpParams

Custom HTTP params for settings like proxy host.

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"

MEDIUM

camel.source.endpoint.accessTokenCache

Custom Access Token Cache for storing and retrieving access tokens.

MEDIUM

camel.source.endpoint.clientSecret

Box application client secret.

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

Enum values:

  • RSA_SHA_256

  • RSA_SHA_384

  • RSA_SHA_512

"RSA_SHA_256"

MEDIUM

camel.source.endpoint.maxCacheEntries

The maximum number of access tokens in cache.

100

MEDIUM

camel.source.endpoint.privateKeyFile

The private key for generating the JWT signature.

MEDIUM

camel.source.endpoint.privateKeyPassword

The password for the private key.

MEDIUM

camel.source.endpoint.publicKeyId

The ID for public key for validating the JWT signature.

MEDIUM

camel.source.endpoint.sslContextParameters

To configure security using SSLContextParameters.

MEDIUM

camel.source.endpoint.userName

Box user name, MUST be provided.

MEDIUM

camel.source.endpoint.userPassword

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

MEDIUM

camel.component.box.clientId

Box application client ID.

MEDIUM

camel.component.box.configuration

To use the shared configuration.

MEDIUM

camel.component.box.enterpriseId

The enterprise ID to use for an App Enterprise.

MEDIUM

camel.component.box.userId

The user ID to use for an App User.

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

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.box.httpParams

Custom HTTP params for settings like proxy host.

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"

MEDIUM

camel.component.box.accessTokenCache

Custom Access Token Cache for storing and retrieving access tokens.

MEDIUM

camel.component.box.clientSecret

Box application client secret.

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

Enum values:

  • RSA_SHA_256

  • RSA_SHA_384

  • RSA_SHA_512

"RSA_SHA_256"

MEDIUM

camel.component.box.maxCacheEntries

The maximum number of access tokens in cache.

100

MEDIUM

camel.component.box.privateKeyFile

The private key for generating the JWT signature.

MEDIUM

camel.component.box.privateKeyPassword

The password for the private key.

MEDIUM

camel.component.box.publicKeyId

The ID for public key for validating the JWT signature.

MEDIUM

camel.component.box.sslContextParameters

To configure security using SSLContextParameters.

MEDIUM

camel.component.box.userName

Box user name, MUST be provided.

MEDIUM

camel.component.box.userPassword

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

MEDIUM

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

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

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

Back to top