Package org.apache.camel.component.kafka

Class KafkaEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.component.kafka.KafkaEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.MultipleConsumersSupport, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.EndpointServiceLocation, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="2.13.0", scheme="kafka", title="Kafka", syntax="kafka:topic", category=MESSAGING, headersClass=KafkaConstants.class) public class KafkaEndpoint extends org.apache.camel.support.DefaultEndpoint implements org.apache.camel.MultipleConsumersSupport, org.apache.camel.spi.EndpointServiceLocation
Send and receive messages to/from an Apache Kafka broker.

  • Field Summary

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

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    KafkaEndpoint()
     
    KafkaEndpoint(String endpointUri, KafkaComponent component)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.camel.Consumer
    createConsumer(org.apache.camel.Processor processor)
     
    ExecutorService
    createExecutor(Object source)
     
    org.apache.camel.Producer
    createProducer()
     
    protected KafkaProducer
    createProducer(KafkaEndpoint endpoint)
     
    ExecutorService
    createProducerExecutor(Object source)
     
    protected void
    doBuild()
     
    KafkaComponent
    getComponent()
     
    KafkaConfiguration
    getConfiguration()
     
    KafkaClientFactory
    getKafkaClientFactory()
     
    KafkaManualCommitFactory
    getKafkaManualCommitFactory()
     
    Map<String,String>
    getServiceMetadata()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    boolean
    isMultipleConsumersSupported()
     
    void
    setConfiguration(KafkaConfiguration configuration)
     
    void
    setKafkaClientFactory(KafkaClientFactory kafkaClientFactory)
    Factory to use for creating KafkaConsumer and KafkaProducer instances.
    void
    setKafkaManualCommitFactory(KafkaManualCommitFactory kafkaManualCommitFactory)
    Factory to use for creating KafkaManualCommit instances.
    void
    updateClassProperties(Properties props)
     

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

    configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

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

    build, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.camel.ComponentAware

    getComponent

    Methods inherited from interface org.apache.camel.Endpoint

    getEndpointBaseUri, isRemote, isSingletonProducer

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

    • KafkaEndpoint

      public KafkaEndpoint()

    • KafkaEndpoint

      public KafkaEndpoint(String endpointUri, KafkaComponent component)

  • Method Details

    • getComponent

      public KafkaComponent getComponent()
      Specified by:
      getComponent in interface org.apache.camel.ComponentAware
      Overrides:
      getComponent in class org.apache.camel.support.DefaultEndpoint

    • getServiceUrl

      public String getServiceUrl()
      Specified by:
      getServiceUrl in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceProtocol

      public String getServiceProtocol()
      Specified by:
      getServiceProtocol in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceMetadata

      public Map<String,String> getServiceMetadata()
      Specified by:
      getServiceMetadata in interface org.apache.camel.spi.EndpointServiceLocation

    • getConfiguration

      public KafkaConfiguration getConfiguration()

    • setConfiguration

      public void setConfiguration(KafkaConfiguration configuration)

    • getKafkaClientFactory

      public KafkaClientFactory getKafkaClientFactory()

    • setKafkaClientFactory

      public void setKafkaClientFactory(KafkaClientFactory kafkaClientFactory)
      Factory to use for creating KafkaConsumer and KafkaProducer instances. This allows to configure a custom factory to create instances with logic that extends the vanilla Kafka clients.

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

    • doBuild

      protected void doBuild() throws Exception
      Overrides:
      doBuild in class org.apache.camel.support.service.BaseService
      Throws:
      Exception

    • createConsumer

      public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception
      Specified by:
      createConsumer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • createProducer

      public org.apache.camel.Producer createProducer() throws Exception
      Specified by:
      createProducer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • isMultipleConsumersSupported

      public boolean isMultipleConsumersSupported()
      Specified by:
      isMultipleConsumersSupported in interface org.apache.camel.MultipleConsumersSupport

    • updateClassProperties

      public void updateClassProperties(Properties props)

    • createExecutor

      public ExecutorService createExecutor(Object source)

    • createProducerExecutor

      public ExecutorService createProducerExecutor(Object source)

    • createProducer

      protected KafkaProducer createProducer(KafkaEndpoint endpoint)