org.apache.camel.component.stub

Class StubEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.seda.SedaEndpoint

org.apache.camel.component.vm.VmEndpoint

org.apache.camel.component.stub.StubEndpoint

All Implemented Interfaces:

AsyncEndpoint, CamelContextAware, Endpoint, IsSingleton, MultipleConsumersSupport, Service, ShutdownableService, BrowsableEndpoint, HasId, StatefulService, SuspendableService

@UriEndpoint(firstVersion="2.10.0",
             scheme="stub",
             title="Stub",
             syntax="stub:name",
             consumerClass=VmConsumer.class,
             label="core,testing")
public class StubEndpoint
extends VmEndpoint

The stub component provides a simple way to stub out any physical endpoints while in development or testing. For example to run a route without needing to actually connect to a specific SMTP or HTTP endpoint. Just add stub: in front of any endpoint URI to stub out the endpoint. Internally the Stub component creates VM endpoints. The main difference between Stub and VM is that VM will validate the URI and parameters you give it, so putting vm: in front of a typical URI with query arguments will usually fail. Stub won't though, as it basically ignores all query parameters to let you quickly stub out one or more endpoints in your route temporarily.

Field Summary

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

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
StubEndpoint(String endpointUri, Component component, BlockingQueue<Exchange> queue)
StubEndpoint(String endpointUri, Component component, BlockingQueue<Exchange> queue, int concurrentConsumers)
StubEndpoint(String endpointUri, Component component, BlockingQueueFactory<Exchange> queueFactory, int concurrentConsumers)

Method Summary

Modifier and Type	Method and Description
protected StubConsumer	createNewConsumer(Processor processor)
Producer	createProducer() Creates a new producer which is used send messages into the endpoint

Methods inherited from class org.apache.camel.component.seda.SedaEndpoint

createConsumer, createPollingConsumer, createQueue, doShutdown, doStart, getComponent, getConcurrentConsumers, getConsumerMulticastProcessor, getConsumers, getCurrentQueueSize, getExchanges, getOfferTimeout, getPollTimeout, getProducers, getQueue, getQueueReference, getSize, getTimeout, getWaitForTaskToComplete, hasConsumers, isBlockWhenFull, isDiscardIfNoConsumers, isFailIfNoConsumers, isLimitConcurrentConsumers, isMultipleConsumers, isMultipleConsumersSupported, isPurgeWhenStopping, isSingleton, purgeQueue, setBlockWhenFull, setConcurrentConsumers, setDiscardIfNoConsumers, setFailIfNoConsumers, setLimitConcurrentConsumers, setMultipleConsumers, setOfferTimeout, setPollTimeout, setPurgeWhenStopping, setQueue, setSize, setTimeout, setWaitForTaskToComplete, shutdown, stop, updateMulticastProcessor

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, doStop, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

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

doResume, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, start, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

configureProperties, createExchange, createExchange, createExchange, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext

Methods inherited from interface org.apache.camel.Service

start

Constructor Detail

StubEndpoint

public StubEndpoint(String endpointUri,
                    Component component,
                    BlockingQueue<Exchange> queue)

StubEndpoint

public StubEndpoint(String endpointUri,
                    Component component,
                    BlockingQueue<Exchange> queue,
                    int concurrentConsumers)

StubEndpoint

public StubEndpoint(String endpointUri,
                    Component component,
                    BlockingQueueFactory<Exchange> queueFactory,
                    int concurrentConsumers)

Method Detail

createNewConsumer

protected StubConsumer createNewConsumer(Processor processor)

Overrides:

createNewConsumer in class VmEndpoint

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface Endpoint

Overrides:

createProducer in class SedaEndpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown