Stub

Stub

Scheme: stub
Syntax: stub:name
Description: The stub component provides a simple way to stub out any physical endpoints while in development or testing.
Deprecated:false
Maven: org.apache.camel/camel-core/2.17.0.redhat-630446

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.

Name Kind Group Required Default Type Enum Description
name path common true java.lang.String Name of queue
size parameter common 2147483647 int The maximum capacity of the SEDA queue (i.e., the number of messages it can hold).
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.

By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.

concurrentConsumers parameter consumer 1 int Number of concurrent threads processing exchanges.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. + Notice if the option bridgeErrorHandler is enabled then this options is not in use. + By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
limitConcurrentConsumers parameter consumer (advanced) true boolean Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off.
multipleConsumers parameter consumer (advanced) boolean Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint.
pollTimeout parameter consumer (advanced) 1000 int The timeout used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown.
purgeWhenStopping parameter consumer (advanced) boolean Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded.
blockWhenFull parameter producer boolean Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted.
discardIfNoConsumers parameter producer boolean Whether the producer should discard the message (do not add the message to the queue), when sending to a queue with no active consumers.

Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.

failIfNoConsumers parameter producer boolean Whether the producer should fail by throwing an exception, when sending to a queue with no active consumers.

Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.

timeout parameter producer 30000 long Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value.
waitForTaskToComplete parameter producer IfReplyExpected org.apache.camel.WaitForTaskToComplete Never
IfReplyExpected
Always
Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The default option is IfReplyExpected.
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange.
queue parameter advanced java.util.concurrent.BlockingQueue Define the queue instance which will be used by the endpoint.

This option is only for rare use-cases where you want to use a custom queue instance.

synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). @param synchronous true to enforce synchronous processing

stub consumer