camel-hbase-kafka-connector source configuration

When using camel-hbase-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-hbase-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.hbase.CamelHbaseSourceConnector

The camel-hbase source connector supports 21 options, which are listed below.

Name	Description	Default	Required	Priority
camel.source.path.tableName	The name of the table	null	true	HIGH
camel.source.endpoint.cellMappingStrategyFactory	To use a custom CellMappingStrategyFactory that is responsible for mapping cells.	null	false	MEDIUM
camel.source.endpoint.filters	A list of filters to use.	null	false	MEDIUM
camel.source.endpoint.mappingStrategyClassName	The class name of a custom mapping strategy implementation.	null	false	MEDIUM
camel.source.endpoint.mappingStrategyName	The strategy to use for mapping Camel messages to HBase columns. Supported values: header, or body. One of: [header] [body]	null	false	MEDIUM
camel.source.endpoint.rowMapping	To map the key/values from the Map to a HBaseRow. The following keys is supported: rowId - The id of the row. This has limited use as the row usually changes per Exchange. rowType - The type to covert row id to. Supported operations: CamelHBaseScan. family - The column family. Supports a number suffix for referring to more than one columns. qualifier - The column qualifier. Supports a number suffix for referring to more than one columns. value - The value. Supports a number suffix for referring to more than one columns valueType - The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet, and CamelHBaseScan.	null	false	MEDIUM
camel.source.endpoint.rowModel	An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled	null	false	MEDIUM
camel.source.endpoint.userGroupInformation	Defines privileges to communicate with HBase such as using kerberos.	null	false	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	false	MEDIUM
camel.source.endpoint.maxMessagesPerPoll	Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited.	null	false	MEDIUM
camel.source.endpoint.operation	The HBase operation to perform One of: [CamelHBasePut] [CamelHBaseGet] [CamelHBaseScan] [CamelHBaseDelete]	null	false	MEDIUM
camel.source.endpoint.remove	If the option is true, Camel HBase Consumer will remove the rows which it processes.	true	false	MEDIUM
camel.source.endpoint.removeHandler	To use a custom HBaseRemoveHandler that is executed when a row is to be removed.	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.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.component.hbase.poolMaxSize	Maximum number of references to keep for each table in the HTable pool. The default value is 10.	10	false	MEDIUM
camel.component.hbase.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.hbase.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.hbase.configuration	To use the shared configuration	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.source.path.tableName

The name of the table

null

true

HIGH

camel.source.endpoint.cellMappingStrategyFactory

To use a custom CellMappingStrategyFactory that is responsible for mapping cells.

null

false

MEDIUM

camel.source.endpoint.filters

A list of filters to use.

null

false

MEDIUM

camel.source.endpoint.mappingStrategyClassName

The class name of a custom mapping strategy implementation.

null

false

MEDIUM

camel.source.endpoint.mappingStrategyName

The strategy to use for mapping Camel messages to HBase columns. Supported values: header, or body. One of: [header] [body]

null

false

MEDIUM

camel.source.endpoint.rowMapping

To map the key/values from the Map to a HBaseRow. The following keys is supported: rowId - The id of the row. This has limited use as the row usually changes per Exchange. rowType - The type to covert row id to. Supported operations: CamelHBaseScan. family - The column family. Supports a number suffix for referring to more than one columns. qualifier - The column qualifier. Supports a number suffix for referring to more than one columns. value - The value. Supports a number suffix for referring to more than one columns valueType - The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet, and CamelHBaseScan.

null

false

MEDIUM

camel.source.endpoint.rowModel

An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled

null

false

MEDIUM

camel.source.endpoint.userGroupInformation

Defines privileges to communicate with HBase such as using kerberos.

null

false

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

Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited.

null

false

MEDIUM

camel.source.endpoint.operation

The HBase operation to perform One of: [CamelHBasePut] [CamelHBaseGet] [CamelHBaseScan] [CamelHBaseDelete]

null

false

MEDIUM

camel.source.endpoint.remove

If the option is true, Camel HBase Consumer will remove the rows which it processes.

true

false

MEDIUM

camel.source.endpoint.removeHandler

To use a custom HBaseRemoveHandler that is executed when a row is to be removed.

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

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

false

MEDIUM

camel.component.hbase.poolMaxSize

Maximum number of references to keep for each table in the HTable pool. The default value is 10.

false

MEDIUM

camel.component.hbase.bridgeErrorHandler

false

MEDIUM

camel.component.hbase.basicPropertyBinding

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

false

LOW

camel.component.hbase.configuration

To use the shared configuration

null

false

MEDIUM

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

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

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