Package 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:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,Block
,ExecutorServiceAwareDefinition<WireTapDefinition<Type>>
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@Metadata(label="eip,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.ToDynamicDefinition
endpointProducerBuilder
-
Fields inherited from class org.apache.camel.model.ProcessorDefinition
inheritErrorHandler
-
-
Constructor Summary
Constructors Constructor Description WireTapDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOutput(ProcessorDefinition<?> output)
Adds the given definition as output to this blockWireTapDefinition<Type>
cacheSize(int cacheSize)
Sets the maximum size used by theProducerCache
which is used to cache and reuse producers, when uris are reused.WireTapDefinition<Type>
cacheSize(String cacheSize)
Sets the maximum size used by theProducerCache
which is used to cache and reuse producers, when uris are reused.WireTapDefinition<Type>
copy()
Uses a copy of the original exchangeWireTapDefinition<Type>
copy(boolean copy)
Uses a copy of the original exchangeWireTapDefinition<Type>
copy(String copy)
Uses a copy of the original exchangeWireTapDefinition<Type>
dynamicUri(boolean dynamicUri)
Whether the uri is dynamic or static.WireTapDefinition<Type>
dynamicUri(String dynamicUri)
Whether the uri is dynamic or static.Type
end()
Ends the current blockWireTapDefinition<Type>
executorService(String executorService)
Uses a custom thread poolWireTapDefinition<Type>
executorService(ExecutorService executorService)
Uses a custom thread poolString
getCopy()
String
getDynamicUri()
String
getExecutorService()
ExecutorService
getExecutorServiceBean()
Gets the executor service for executingString
getExecutorServiceRef()
Gets a reference id to lookup the executor service from the registryString
getLabel()
Returns a label to describe this node such as the expression if some kind of expression nodeString
getOnPrepare()
org.apache.camel.Processor
getOnPrepareProcessor()
String
getPattern()
String
getShortName()
String
getUri()
WireTapDefinition<Type>
ignoreInvalidEndpoint()
Ignore the invalid endpoint exception when try to create a producer with that endpointWireTapDefinition<Type>
onPrepare(String onPrepare)
Uses theProcessor
when preparing theExchange
to be sent.WireTapDefinition<Type>
onPrepare(org.apache.camel.Processor onPrepare)
Uses theProcessor
when preparing theExchange
to be sent.void
setCopy(String copy)
void
setDynamicUri(String dynamicUri)
void
setExecutorService(String executorService)
void
setOnPrepare(String onPrepare)
void
setUri(String uri)
The uri of the endpoint to wiretap to.String
toString()
-
Methods inherited from class org.apache.camel.model.ToDynamicDefinition
allowOptimisedComponents, allowOptimisedComponents, autoStartComponents, getAllowOptimisedComponents, getAutoStartComponents, getCacheSize, getEndpointProducerBuilder, getIgnoreInvalidEndpoint, ignoreInvalidEndpoint, ignoreInvalidEndpoint, pattern, pattern, setAllowOptimisedComponents, setAutoStartComponents, setCacheSize, setEndpointProducerBuilder, setIgnoreInvalidEndpoint, setPattern, uri, uri
-
Methods inherited from class org.apache.camel.model.NoOutputDefinition
getOutputs
-
Methods inherited from class org.apache.camel.model.ProcessorDefinition
addInterceptStrategy, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, convertBodyTo, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pausable, pausable, pausable, pausable, pipeline, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, sort, sort, sort, split, split, split, split, startupOrder, step, step, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap
-
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
-
-
-
Method Detail
-
getPattern
public String getPattern()
- Overrides:
getPattern
in classToDynamicDefinition
-
toString
public String toString()
- Overrides:
toString
in classToDynamicDefinition
-
getShortName
public String getShortName()
- Specified by:
getShortName
in interfaceorg.apache.camel.NamedNode
- Overrides:
getShortName
in classToDynamicDefinition
-
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 interfaceorg.apache.camel.NamedNode
- Overrides:
getLabel
in classToDynamicDefinition
-
end
public Type end()
Description copied from class:ProcessorDefinition
Ends the current block- Overrides:
end
in classProcessorDefinition<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 interfaceBlock
- Overrides:
addOutput
in classProcessorDefinition<ToDynamicDefinition>
- Parameters:
output
- the processor definition
-
executorService
public WireTapDefinition<Type> executorService(ExecutorService executorService)
Uses a custom thread pool- Specified by:
executorService
in interfaceExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
- Parameters:
executorService
- a customExecutorService
to use as thread pool for sending tapped exchanges- Returns:
- the builder
-
executorService
public WireTapDefinition<Type> executorService(String executorService)
Uses a custom thread pool- Specified by:
executorService
in interfaceExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
- Parameters:
executorService
- reference to lookup a customExecutorService
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
-
copy
public WireTapDefinition<Type> copy(String 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
-
dynamicUri
public WireTapDefinition<Type> dynamicUri(String 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
-
onPrepare
public WireTapDefinition<Type> onPrepare(org.apache.camel.Processor onPrepare)
Uses theProcessor
when preparing theExchange
to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.- Parameters:
onPrepare
- the processor- Returns:
- the builder
-
onPrepare
public WireTapDefinition<Type> onPrepare(String onPrepare)
Uses theProcessor
when preparing theExchange
to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.- Parameters:
onPrepare
- reference to the processor to lookup in theRegistry
- Returns:
- the builder
-
cacheSize
public WireTapDefinition<Type> cacheSize(int cacheSize)
Sets the maximum size used by theProducerCache
which is used to cache and reuse producers, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then it's best to turn of caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non-frequent used producers.- Overrides:
cacheSize
in classToDynamicDefinition
- Parameters:
cacheSize
- the cache size, use 0 for default cache size, or -1 to turn cache off.- Returns:
- the builder
-
cacheSize
public WireTapDefinition<Type> cacheSize(String cacheSize)
Sets the maximum size used by theProducerCache
which is used to cache and reuse producers, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then it's best to turn of caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non-frequent used producers.- Overrides:
cacheSize
in classToDynamicDefinition
- 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 invalid endpoint exception when try to create a producer with that endpoint- Returns:
- the builder
-
getOnPrepareProcessor
public org.apache.camel.Processor getOnPrepareProcessor()
-
getExecutorServiceBean
public ExecutorService getExecutorServiceBean()
Description copied from interface:ExecutorServiceAwareDefinition
Gets the executor service for executing- Specified by:
getExecutorServiceBean
in interfaceExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
-
getExecutorServiceRef
public String getExecutorServiceRef()
Description copied from interface:ExecutorServiceAwareDefinition
Gets a reference id to lookup the executor service from the registry- Specified by:
getExecutorServiceRef
in interfaceExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
-
getUri
public String getUri()
- Overrides:
getUri
in classToDynamicDefinition
-
setUri
public void setUri(String uri)
The uri of the endpoint to wiretap to. The uri can be dynamic computed using the simple language.- Overrides:
setUri
in classToDynamicDefinition
-
getCopy
public String getCopy()
-
setCopy
public void setCopy(String copy)
-
getDynamicUri
public String getDynamicUri()
-
setDynamicUri
public void setDynamicUri(String dynamicUri)
-
getOnPrepare
public String getOnPrepare()
-
setOnPrepare
public void setOnPrepare(String onPrepare)
-
getExecutorService
public String getExecutorService()
-
setExecutorService
public void setExecutorService(String executorService)
-
-