org.apache.camel.model

Class WireTapDefinition<Type extends ProcessorDefinition<Type>>

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<Type>

org.apache.camel.model.NoOutputDefinition<ToDynamicDefinition>

org.apache.camel.model.ToDynamicDefinition

org.apache.camel.model.WireTapDefinition<Type>

All Implemented Interfaces:

ExecutorServiceAware, Block, ExecutorServiceAwareDefinition<WireTapDefinition<Type>>, OtherAttributesAware, NamedNode

@Metadata(label="eip,endpoint,routing")
public class WireTapDefinition<Type extends ProcessorDefinition<Type>>
extends ToDynamicDefinition
implements ExecutorServiceAwareDefinition<WireTapDefinition<Type>>

Routes a copy of a message (or creates a new message) to a secondary destination while continue routing the original message.

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
WireTapDefinition()

Method Summary

Modifier and Type	Method and Description
void	addOutput(ProcessorDefinition<?> output) Adds the given definition as output to this block
WireTapDefinition<Type>	cacheSize(int cacheSize) Sets the maximum size used by the ProducerCache which is used to cache and reuse producers, when uris are reused.
WireTapDefinition<Type>	copy() Uses a copy of the original exchange
WireTapDefinition<Type>	copy(boolean copy) Uses a copy of the original exchange
protected Expression	createExpression(RouteContext routeContext)
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
WireTapDefinition<Type>	dynamicUri(boolean dynamicUri) Whether the uri is dynamic or static.
Type	end() Ends the current block
WireTapDefinition<Type>	executorService(ExecutorService executorService) Uses a custom thread pool
WireTapDefinition<Type>	executorServiceRef(String executorServiceRef) Uses a custom thread pool
Boolean	getCopy()
Boolean	getDynamicUri()
ExecutorService	getExecutorService() Gets the executor service
String	getExecutorServiceRef() Gets the reference to lookup in the Registry for the executor service to be used.
List<SetHeaderDefinition>	getHeaders()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
ExpressionSubElementDefinition	getNewExchangeExpression()
Processor	getNewExchangeProcessor()
String	getNewExchangeProcessorRef()
Processor	getOnPrepare()
String	getOnPrepareRef()
ExchangePattern	getPattern()
String	getUri()
WireTapDefinition<Type>	ignoreInvalidEndpoint() Ignore the invalidate endpoint exception when try to create a producer with that endpoint
WireTapDefinition<Type>	newExchange(Expression expression) Deprecated. will be removed in Camel 3.0 Instead use newExchangeBody(org.apache.camel.Expression)
WireTapDefinition<Type>	newExchange(Processor processor) Sends a new Exchange, instead of tapping an existing, using ExchangePattern.InOnly
WireTapDefinition<Type>	newExchangeBody(Expression expression) Sends a new Exchange, instead of tapping an existing, using ExchangePattern.InOnly
WireTapDefinition<Type>	newExchangeHeader(String headerName, Expression expression) Sets a header on the new Exchange, instead of tapping an existing, using ExchangePattern.InOnly.
WireTapDefinition<Type>	newExchangeRef(String ref) Sends a new Exchange, instead of tapping an existing, using ExchangePattern.InOnly
WireTapDefinition<Type>	onPrepare(Processor onPrepare) Uses the Processor when preparing the Exchange to be send.
WireTapDefinition<Type>	onPrepareRef(String onPrepareRef) Uses the Processor when preparing the Exchange to be send.
void	setCopy(Boolean copy)
void	setDynamicUri(Boolean dynamicUri)
void	setExecutorService(ExecutorService executorService) Sets the executor service to be used.
void	setExecutorServiceRef(String executorServiceRef) Sets a reference to lookup in the Registry for the executor service to be used.
void	setHeaders(List<SetHeaderDefinition> headers)
void	setNewExchangeExpression(ExpressionSubElementDefinition newExchangeExpression) Uses the expression for creating a new body as the message to use for wire tapping
void	setNewExchangeProcessor(Processor processor) To use a Processor for creating a new body as the message to use for wire tapping
void	setNewExchangeProcessorRef(String ref) Reference to a Processor to use for creating a new body as the message to use for wire tapping
void	setOnPrepare(Processor onPrepare)
void	setOnPrepareRef(String onPrepareRef)
void	setUri(String uri) The uri of the endpoint to wiretap to.
String	toString()

Methods inherited from class org.apache.camel.model.ToDynamicDefinition

allowOptimisedComponents, getAllowOptimisedComponents, getCacheSize, getIgnoreInvalidEndpoint, pattern, setAllowOptimisedComponents, setCacheSize, setIgnoreInvalidEndpoint, setPattern

Methods inherited from class org.apache.camel.model.NoOutputDefinition

getOutputs, isOutputSupported

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategies, addInterceptStrategy, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCustomId, getDescription, getDescriptionText, getId, getShortName, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WireTapDefinition

public WireTapDefinition()

Method Detail

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Description copied from class: ProcessorDefinition

Override this in definition class and implement logic to create the processor based on the definition model.

Overrides:

createProcessor in class ToDynamicDefinition

Throws:

Exception

createExpression

protected Expression createExpression(RouteContext routeContext)

Overrides:

createExpression in class ToDynamicDefinition

getPattern

public ExchangePattern getPattern()

Overrides:

getPattern in class ToDynamicDefinition

toString

public String toString()

Overrides:

toString in class ToDynamicDefinition

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface NamedNode

Overrides:

getLabel in class ProcessorDefinition<ToDynamicDefinition>

end

public Type end()

Description copied from class: ProcessorDefinition

Ends the current block

Overrides:

end in class ProcessorDefinition<ToDynamicDefinition>

Returns:

the builder

addOutput

public void addOutput(ProcessorDefinition<?> output)

Description copied from interface: Block

Adds the given definition as output to this block

Specified by:

addOutput in interface Block

Overrides:

addOutput in class ProcessorDefinition<ToDynamicDefinition>

Parameters:

output - the processor definition

executorService

public WireTapDefinition<Type> executorService(ExecutorService executorService)

Uses a custom thread pool

Specified by:

executorService in interface ExecutorServiceAwareDefinition<WireTapDefinition<Type extends ProcessorDefinition<Type>>>

Parameters:

executorService - a custom ExecutorService to use as thread pool for sending tapped exchanges

Returns:

the builder

executorServiceRef

public WireTapDefinition<Type> executorServiceRef(String executorServiceRef)

Uses a custom thread pool

Specified by:

executorServiceRef in interface ExecutorServiceAwareDefinition<WireTapDefinition<Type extends ProcessorDefinition<Type>>>

Parameters:

executorServiceRef - reference to lookup a custom ExecutorService to use as thread pool for sending tapped exchanges

Returns:

the builder

copy

public WireTapDefinition<Type> copy()

Uses a copy of the original exchange

Returns:

the builder

copy

public WireTapDefinition<Type> copy(boolean copy)

Uses a copy of the original exchange

Parameters:

copy - if it is true camel will copy the original exchange, if it is false camel will not copy the original exchange

Returns:

the builder

dynamicUri

public WireTapDefinition<Type> dynamicUri(boolean dynamicUri)

Whether the uri is dynamic or static. If the uri is dynamic then the simple language is used to evaluate a dynamic uri to use as the wire-tap destination, for each incoming message. This works similar to how the toD EIP pattern works. If static then the uri is used as-is as the wire-tap destination.

Parameters:

dynamicUri - whether to use dynamic or static uris

Returns:

the builder

newExchange

@Deprecated
public WireTapDefinition<Type> newExchange(Expression expression)

Deprecated. will be removed in Camel 3.0 Instead use newExchangeBody(org.apache.camel.Expression)

newExchangeBody

public WireTapDefinition<Type> newExchangeBody(Expression expression)

Sends a new Exchange, instead of tapping an existing, using ExchangePattern.InOnly

Parameters:

expression - expression that creates the new body to send

Returns:

the builder

See Also:

newExchangeHeader(String, org.apache.camel.Expression)

newExchangeRef

public WireTapDefinition<Type> newExchangeRef(String ref)

Sends a new Exchange, instead of tapping an existing, using ExchangePattern.InOnly

Parameters:

ref - reference to the Processor to lookup in the Registry to be used for preparing the new exchange to send

Returns:

the builder

newExchange

public WireTapDefinition<Type> newExchange(Processor processor)

Sends a new Exchange, instead of tapping an existing, using ExchangePattern.InOnly

Parameters:

processor - processor preparing the new exchange to send

Returns:

the builder

See Also:

newExchangeHeader(String, org.apache.camel.Expression)

newExchangeHeader

public WireTapDefinition<Type> newExchangeHeader(String headerName,
                                                 Expression expression)

Sets a header on the new Exchange, instead of tapping an existing, using ExchangePattern.InOnly.

Use this together with the newExchange(org.apache.camel.Expression) or newExchange(org.apache.camel.Processor) methods.

Parameters:

headerName - the header name

expression - the expression setting the header value

Returns:

the builder

onPrepare

public WireTapDefinition<Type> onPrepare(Processor onPrepare)

Uses the Processor when preparing the Exchange to be send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send.

Parameters:

onPrepare - the processor

Returns:

the builder

onPrepareRef

public WireTapDefinition<Type> onPrepareRef(String onPrepareRef)

Uses the Processor when preparing the Exchange to be send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send.

Parameters:

onPrepareRef - reference to the processor to lookup in the Registry

Returns:

the builder

cacheSize

public WireTapDefinition<Type> cacheSize(int cacheSize)

Sets the maximum size used by the ProducerCache which is used to cache and reuse producers, when uris are reused.

Overrides:

cacheSize in class ToDynamicDefinition

Parameters:

cacheSize - the cache size, use 0 for default cache size, or -1 to turn cache off.

Returns:

the builder

ignoreInvalidEndpoint

public WireTapDefinition<Type> ignoreInvalidEndpoint()

Ignore the invalidate endpoint exception when try to create a producer with that endpoint

Overrides:

ignoreInvalidEndpoint in class ToDynamicDefinition

Returns:

the builder

getUri

public String getUri()

Overrides:

getUri in class ToDynamicDefinition

setUri

public void setUri(String uri)

The uri of the endpoint to wiretap to. The uri can be dynamic computed using the SimpleLanguage expression.

Overrides:

setUri in class ToDynamicDefinition

getNewExchangeProcessor

public Processor getNewExchangeProcessor()

setNewExchangeProcessor

public void setNewExchangeProcessor(Processor processor)

To use a Processor for creating a new body as the message to use for wire tapping

getNewExchangeProcessorRef

public String getNewExchangeProcessorRef()

setNewExchangeProcessorRef

public void setNewExchangeProcessorRef(String ref)

Reference to a Processor to use for creating a new body as the message to use for wire tapping

getNewExchangeExpression

public ExpressionSubElementDefinition getNewExchangeExpression()

setNewExchangeExpression

public void setNewExchangeExpression(ExpressionSubElementDefinition newExchangeExpression)

Uses the expression for creating a new body as the message to use for wire tapping

getExecutorService

public ExecutorService getExecutorService()

Description copied from interface: ExecutorServiceAware

Gets the executor service

Specified by:

getExecutorService in interface ExecutorServiceAware

Returns:

the executor

setExecutorService

public void setExecutorService(ExecutorService executorService)

Description copied from interface: ExecutorServiceAware

Sets the executor service to be used.

Specified by:

setExecutorService in interface ExecutorServiceAware

Parameters:

executorService - the executor

getExecutorServiceRef

public String getExecutorServiceRef()

Description copied from interface: ExecutorServiceAware

Gets the reference to lookup in the Registry for the executor service to be used.

Specified by:

getExecutorServiceRef in interface ExecutorServiceAware

Returns:

the reference, or null if the executor was set directly

setExecutorServiceRef

public void setExecutorServiceRef(String executorServiceRef)

Description copied from interface: ExecutorServiceAware

Sets a reference to lookup in the Registry for the executor service to be used.

Specified by:

setExecutorServiceRef in interface ExecutorServiceAware

Parameters:

executorServiceRef - reference for the executor

getCopy

public Boolean getCopy()

setCopy

public void setCopy(Boolean copy)

getDynamicUri

public Boolean getDynamicUri()

setDynamicUri

public void setDynamicUri(Boolean dynamicUri)

getOnPrepareRef

public String getOnPrepareRef()

setOnPrepareRef

public void setOnPrepareRef(String onPrepareRef)

getOnPrepare

public Processor getOnPrepare()

setOnPrepare

public void setOnPrepare(Processor onPrepare)

getHeaders

public List<SetHeaderDefinition> getHeaders()

setHeaders

public void setHeaders(List<SetHeaderDefinition> headers)