Package org.apache.camel.component.vertx.kafka

Class VertxKafkaComponent

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    @Component("vertx-kafka")
public class VertxKafkaComponent
extends org.apache.camel.support.DefaultComponent

    • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.apache.camel.Endpoint createEndpoint​(String uri, String remaining, Map<String,​Object> parameters)  
      protected void doStart()  
      protected void doStop()  
      VertxKafkaConfiguration getConfiguration()
      The component configurations
      VertxKafkaManualCommitFactory getKafkaManualCommitFactory()
      Factory to use for creating VertxKafkaManualCommit instances.
      io.vertx.core.Vertx getVertx()  
      VertxKafkaClientFactory getVertxKafkaClientFactory()  
      io.vertx.core.VertxOptions getVertxOptions()  
      void setConfiguration​(VertxKafkaConfiguration configuration)  
      void setKafkaManualCommitFactory​(VertxKafkaManualCommitFactory kafkaManualCommitFactory)  
      void setVertx​(io.vertx.core.Vertx vertx)
      To use an existing vertx instead of creating a new instance
      void setVertxKafkaClientFactory​(VertxKafkaClientFactory vertxKafkaClientFactory)
      Factory to use for creating and instances.
      void setVertxOptions​(io.vertx.core.VertxOptions vertxOptions)
      To provide a custom set of vertx options for configuring vertx

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

        afterConfiguration, createEndpoint, createEndpoint, doBuild, doInit, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

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

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

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

      • VertxKafkaComponent

        public VertxKafkaComponent()

      • VertxKafkaComponent

        public VertxKafkaComponent​(org.apache.camel.CamelContext context)

    • Method Detail

      • createEndpoint

        protected org.apache.camel.Endpoint createEndpoint​(String uri,
                                                   String remaining,
                                                   Map<String,​Object> parameters)
                                            throws Exception
        Specified by:
        createEndpoint in class org.apache.camel.support.DefaultComponent
        Throws:
        Exception

      • doStart

        protected void doStart()
                throws Exception
        Overrides:
        doStart in class org.apache.camel.support.DefaultComponent
        Throws:
        Exception

      • doStop

        protected void doStop()
               throws Exception
        Overrides:
        doStop in class org.apache.camel.support.DefaultComponent
        Throws:
        Exception

      • getVertx

        public io.vertx.core.Vertx getVertx()

      • setVertx

        public void setVertx​(io.vertx.core.Vertx vertx)
        To use an existing vertx instead of creating a new instance

      • getVertxOptions

        public io.vertx.core.VertxOptions getVertxOptions()

      • setVertxOptions

        public void setVertxOptions​(io.vertx.core.VertxOptions vertxOptions)
        To provide a custom set of vertx options for configuring vertx

      • setVertxKafkaClientFactory

        public void setVertxKafkaClientFactory​(VertxKafkaClientFactory vertxKafkaClientFactory)
        Factory to use for creating and instances. This allows to configure a custom factory to create custom KafkaConsumer and KafkaProducer instances with logic that extends the vanilla VertX Kafka clients.

      • getKafkaManualCommitFactory

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