Package org.apache.camel.component.kamelet

Class KameletEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.component.kamelet.KameletEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="3.8.0", scheme="kamelet", syntax="kamelet:templateId/routeId", title="Kamelet", lenientProperties=true, category=CORE) public class KameletEndpoint extends org.apache.camel.support.DefaultEndpoint

  • 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
    KameletEndpoint(String uri, KameletComponent component, String templateId, String routeId)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.camel.Consumer
    createConsumer(org.apache.camel.Processor processor)
     
    org.apache.camel.Producer
    createProducer()
     
    KameletComponent
    getComponent()
     
    Map<String,Object>
    getKameletProperties()
     
    String
    getLocation()
     
    String
    getRouteId()
     
    String
    getTemplateId()
     
    long
    getTimeout()
     
    boolean
    isBlock()
     
    boolean
    isFailIfNoConsumers()
     
    boolean
    isLenientProperties()
     
    boolean
    isNoErrorHandler()
     
    boolean
    isSingleton()
     
    void
    setBlock(boolean block)
    If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active.
    void
    setFailIfNoConsumers(boolean failIfNoConsumers)
    Whether the producer should fail by throwing an exception, when sending to a kamelet endpoint with no active consumers.
    void
    setKameletProperties(Map<String,Object> kameletProperties)
    Custom properties for kamelet
    void
    setLocation(String location)
     
    void
    setNoErrorHandler(boolean noErrorHandler)
    Kamelets, by default, will not do fine-grained error handling, but works in no-error-handler mode.
    void
    setProperties(Object bean, Map<String,Object> parameters)
     
    void
    setTimeout(long timeout)
    The timeout value to use if block is enabled.

    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, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, toString

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

    build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, 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 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, 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

  • Method Details

    • isNoErrorHandler

      public boolean isNoErrorHandler()

    • setNoErrorHandler

      public void setNoErrorHandler(boolean noErrorHandler)
      Kamelets, by default, will not do fine-grained error handling, but works in no-error-handler mode. This can be turned off, to use old behaviour in earlier versions of Camel.

    • isBlock

      public boolean isBlock()

    • setBlock

      public void setBlock(boolean block)
      If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active.

    • getTimeout

      public long getTimeout()

    • setTimeout

      public void setTimeout(long timeout)
      The timeout value to use if block is enabled.
      Parameters:
      timeout - the timeout value

    • isFailIfNoConsumers

      public boolean isFailIfNoConsumers()

    • setFailIfNoConsumers

      public void setFailIfNoConsumers(boolean failIfNoConsumers)
      Whether the producer should fail by throwing an exception, when sending to a kamelet endpoint with no active consumers.

    • getComponent

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

    • isLenientProperties

      public boolean isLenientProperties()
      Specified by:
      isLenientProperties in interface org.apache.camel.Endpoint
      Overrides:
      isLenientProperties in class org.apache.camel.support.DefaultEndpoint

    • isSingleton

      public boolean isSingleton()
      Specified by:
      isSingleton in interface org.apache.camel.IsSingleton
      Overrides:
      isSingleton in class org.apache.camel.support.DefaultEndpoint

    • getTemplateId

      public String getTemplateId()

    • getRouteId

      public String getRouteId()

    • getLocation

      public String getLocation()

    • setLocation

      public void setLocation(String location)

    • getKameletProperties

      public Map<String,Object> getKameletProperties()

    • setKameletProperties

      public void setKameletProperties(Map<String,Object> kameletProperties)
      Custom properties for kamelet

    • createProducer

      public org.apache.camel.Producer createProducer() throws Exception
      Throws:
      Exception

    • createConsumer

      public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception
      Throws:
      Exception

    • setProperties

      public void setProperties(Object bean, Map<String,Object> parameters)
      Overrides:
      setProperties in class org.apache.camel.support.DefaultEndpoint