org.apache.camel.component.kafka

Class KafkaComponent

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultComponent

org.apache.camel.component.kafka.KafkaComponent

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.SSLContextParametersAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@Component(value="kafka")
public class KafkaComponent
extends org.apache.camel.support.DefaultComponent
implements org.apache.camel.SSLContextParametersAware

Field Summary

Fields inherited from class org.apache.camel.support.service.ServiceSupport

BUILDED, FAILED, INITIALIZED, lock, log, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
KafkaComponent()
KafkaComponent(org.apache.camel.CamelContext context)

Method Summary

Modifier and Type	Method and Description
protected KafkaEndpoint	createEndpoint(String uri, String remaining, Map<String,Object> params)
String	getBrokers()
KafkaConfiguration	getConfiguration()
KafkaManualCommitFactory	getKafkaManualCommitFactory()
ExecutorService	getWorkerPool()
boolean	isAllowManualCommit()
boolean	isBreakOnFirstError()
boolean	isUseGlobalSslContextParameters()
void	setAllowManualCommit(boolean allowManualCommit) Whether to allow doing manual commits via KafkaManualCommit.
void	setBreakOnFirstError(boolean breakOnFirstError) This options controls what happens when a consumer is processing an exchange and it fails.
void	setBrokers(String brokers) URL of the Kafka brokers to use.
void	setConfiguration(KafkaConfiguration configuration) Allows to pre-configure the Kafka component with common options that the endpoints will reuse.
void	setKafkaManualCommitFactory(KafkaManualCommitFactory kafkaManualCommitFactory) Factory to use for creating KafkaManualCommit instances.
void	setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.
void	setWorkerPool(ExecutorService workerPool) To use a shared custom worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing.

Methods inherited from class org.apache.camel.support.DefaultComponent

afterConfiguration, createEndpoint, createEndpoint, doInit, doStart, doStop, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, preProcessUri, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

Methods inherited from class org.apache.camel.support.service.ServiceSupport

build, doBuild, doResume, doShutdown, doSuspend, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.camel.SSLContextParametersAware

retrieveGlobalSslContextParameters

Methods inherited from interface org.apache.camel.CamelContextAware

getCamelContext, setCamelContext, trySetCamelContext

Methods inherited from interface org.apache.camel.Component

trySetComponent

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Constructor Detail

KafkaComponent

public KafkaComponent()

KafkaComponent

public KafkaComponent(org.apache.camel.CamelContext context)

Method Detail

createEndpoint

protected KafkaEndpoint createEndpoint(String uri,
                                       String remaining,
                                       Map<String,Object> params)
                                throws Exception

Specified by:

createEndpoint in class org.apache.camel.support.DefaultComponent

Throws:

Exception

getConfiguration

public KafkaConfiguration getConfiguration()

setConfiguration

public void setConfiguration(KafkaConfiguration configuration)

Allows to pre-configure the Kafka component with common options that the endpoints will reuse.

getBrokers

public String getBrokers()

setBrokers

public void setBrokers(String brokers)

URL of the Kafka brokers to use. The format is host1:port1,host2:port2, and the list can be a subset of brokers or a VIP pointing to a subset of brokers.

This option is known as bootstrap.servers in the Kafka documentation.

getWorkerPool

public ExecutorService getWorkerPool()

setWorkerPool

public void setWorkerPool(ExecutorService workerPool)

To use a shared custom worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing. If using this option then you must handle the lifecycle of the thread pool to shut the pool down when no longer needed.

isUseGlobalSslContextParameters

public boolean isUseGlobalSslContextParameters()

Specified by:

isUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

setUseGlobalSslContextParameters

public void setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)

Enable usage of global SSL context parameters.

Specified by:

setUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

isBreakOnFirstError

public boolean isBreakOnFirstError()

setBreakOnFirstError

public void setBreakOnFirstError(boolean breakOnFirstError)

This options controls what happens when a consumer is processing an exchange and it fails. If the option is false then the consumer continues to the next message and processes it. If the option is true then the consumer breaks out, and will seek back to offset of the message that caused a failure, and then re-attempt to process this message. However this can lead to endless processing of the same message if its bound to fail every time, eg a poison message. Therefore its recommended to deal with that for example by using Camel's error handler.

isAllowManualCommit

public boolean isAllowManualCommit()

setAllowManualCommit

public void setAllowManualCommit(boolean allowManualCommit)

Whether to allow doing manual commits via KafkaManualCommit.

If this option is enabled then an instance of KafkaManualCommit is stored on the Exchange message header, which allows end users to access this API and perform manual offset commits via the Kafka consumer.

getKafkaManualCommitFactory

public KafkaManualCommitFactory getKafkaManualCommitFactory()

setKafkaManualCommitFactory

public void setKafkaManualCommitFactory(KafkaManualCommitFactory kafkaManualCommitFactory)

Factory to use for creating KafkaManualCommit instances. This allows to plugin a custom factory to create custom KafkaManualCommit instances in case special logic is needed when doing manual commits that deviates from the default implementation that comes out of the box.