Package org.apache.camel.component.stub

Class StubComponent

  • 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("stub")
public class StubComponent
extends org.apache.camel.component.vm.VmComponent
    The Stub Component is for stubbing out endpoints while developing or testing. Allows you to easily stub out a middleware transport by prefixing the URI with "stub:" which is handy for testing out routes, or isolating bits of middleware.

    • Field Summary

      • Fields inherited from class org.apache.camel.component.vm.VmComponent

        ENDPOINTS, QUEUES

      • Fields inherited from class org.apache.camel.component.seda.SedaComponent

        concurrentConsumers, defaultQueueFactory, log, maxConcurrentConsumers, queueSize

      • 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
      StubComponent()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected StubEndpoint createEndpoint​(String endpointUri, org.apache.camel.Component component, BlockingQueue<org.apache.camel.Exchange> queue, int concurrentConsumers)  
      protected StubEndpoint createEndpoint​(String endpointUri, org.apache.camel.Component component, org.apache.camel.component.seda.BlockingQueueFactory<org.apache.camel.Exchange> queueFactory, int concurrentConsumers)  
      protected void doInit()  
      boolean isShadow()  
      protected String resolveShadowUri​(String uri)
      Strategy to resolve the shadow uri to use for the stub endpoints
      void setShadow​(boolean shadow)
      If shadow is enabled then the stub component will register a shadow endpoint with the actual uri that refers to the stub endpoint, meaning you can lookup the endpoint via both stub:kafka:cheese and kafka:cheese.
      protected void validateParameters​(String uri, Map<String,​Object> parameters, String optionPrefix)  
      protected void validateURI​(String uri, String path, Map<String,​Object> parameters)  

      • Methods inherited from class org.apache.camel.component.vm.VmComponent

        createEndpoint, doStart, doStop, getQueueReference, getQueues

      • Methods inherited from class org.apache.camel.component.seda.SedaComponent

        getConcurrentConsumers, getDefaultOfferTimeout, getDefaultPollTimeout, getDefaultQueueFactory, getOrCreateQueue, getQueueKey, getQueueSize, isDefaultBlockWhenFull, isDefaultDiscardWhenFull, registerQueue, setConcurrentConsumers, setDefaultBlockWhenFull, setDefaultDiscardWhenFull, setDefaultOfferTimeout, setDefaultPollTimeout, setDefaultQueueFactory, setQueueSize

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

        afterConfiguration, createEndpoint, createEndpoint, doBuild, 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

      • 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

      • StubComponent

        public StubComponent()

    • Method Detail

      • validateURI

        protected void validateURI​(String uri,
                           String path,
                           Map<String,​Object> parameters)
        Overrides:
        validateURI in class org.apache.camel.support.DefaultComponent

      • validateParameters

        protected void validateParameters​(String uri,
                                  Map<String,​Object> parameters,
                                  String optionPrefix)
        Overrides:
        validateParameters in class org.apache.camel.support.DefaultComponent

      • createEndpoint

        protected StubEndpoint createEndpoint​(String endpointUri,
                                      org.apache.camel.Component component,
                                      org.apache.camel.component.seda.BlockingQueueFactory<org.apache.camel.Exchange> queueFactory,
                                      int concurrentConsumers)
        Overrides:
        createEndpoint in class org.apache.camel.component.vm.VmComponent

      • createEndpoint

        protected StubEndpoint createEndpoint​(String endpointUri,
                                      org.apache.camel.Component component,
                                      BlockingQueue<org.apache.camel.Exchange> queue,
                                      int concurrentConsumers)
        Overrides:
        createEndpoint in class org.apache.camel.component.vm.VmComponent

      • resolveShadowUri

        protected String resolveShadowUri​(String uri)
        Strategy to resolve the shadow uri to use for the stub endpoints

      • isShadow

        public boolean isShadow()

      • setShadow

        public void setShadow​(boolean shadow)
        If shadow is enabled then the stub component will register a shadow endpoint with the actual uri that refers to the stub endpoint, meaning you can lookup the endpoint via both stub:kafka:cheese and kafka:cheese.

      • doInit

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