Package org.apache.camel.model
Class DynamicRouterDefinition<Type extends ProcessorDefinition<Type>>
java.lang.Object
org.apache.camel.model.OptionalIdentifiedDefinition<ExpressionNode>
org.apache.camel.model.ProcessorDefinition<ExpressionNode>
org.apache.camel.model.ExpressionNode
org.apache.camel.model.DynamicRouterDefinition<Type>
- All Implemented Interfaces:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,Block
,HasExpressionType
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasCamelContext
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@Metadata(label="eip,routing")
public class DynamicRouterDefinition<Type extends ProcessorDefinition<Type>>
extends ExpressionNode
Route messages based on dynamic rules
-
Field Summary
FieldsFields inherited from class org.apache.camel.model.ProcessorDefinition
disabled, inheritErrorHandler
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncacheSize
(int cacheSize) Sets the maximum size used by theProducerCache
which is used to cache and reuse producers when using this dynamic router, when uris are reused.Sets the maximum size used by theProducerCache
which is used to cache and reuse producers when using this dynamic router, when uris are reused.end()
Ends the current blockgetLabel()
Returns a label to describe this node such as the expression if some kind of expression nodeIgnore the invalidate endpoint exception when try to create a producer with that endpointvoid
setCacheSize
(String cacheSize) void
setExpression
(ExpressionDefinition expression) Expression to call that returns the endpoint(s) to route to in the dynamic routing.void
setIgnoreInvalidEndpoints
(String ignoreInvalidEndpoints) void
setUriDelimiter
(String uriDelimiter) toString()
uriDelimiter
(String uriDelimiter) Sets the uri delimiter to useMethods inherited from class org.apache.camel.model.ExpressionNode
configureChild, getExpression, getExpressionType, id, preCreateProcessor, setExpression, setExpressionType
Methods inherited from class org.apache.camel.model.ProcessorDefinition
addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, convertBodyTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertVariableTo, convertVariableTo, convertVariableTo, convertVariableTo, delay, delay, delay, disabled, disabled, disabled, 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, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, 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, nodePrefixId, onCompletion, onException, onException, onException, onException, pausable, pausable, pausable, pausable, 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, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, removeVariable, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setHeaders, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, setVariable, setVariable, setVariable, 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, toD, toD, toD, toD, toD, toD, toD, toD, toD, toF, toV, transacted, transacted, transform, transform, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, getNodePrefixId, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
Field Details
-
DEFAULT_DELIMITER
- See Also:
-
-
Constructor Details
-
DynamicRouterDefinition
public DynamicRouterDefinition() -
DynamicRouterDefinition
public DynamicRouterDefinition(org.apache.camel.Expression expression)
-
-
Method Details
-
toString
-
getShortName
-
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 classExpressionNode
-
getOutputs
- Overrides:
getOutputs
in classExpressionNode
-
setExpression
Expression to call that returns the endpoint(s) to route to in the dynamic routing. Important: The expression will be called in a while loop fashion, until the expression returns null which means the dynamic router is finished.- Overrides:
setExpression
in classExpressionNode
-
setUriDelimiter
-
getUriDelimiter
-
setIgnoreInvalidEndpoints
-
getIgnoreInvalidEndpoints
-
getCacheSize
-
setCacheSize
-
end
Description copied from class:ProcessorDefinition
Ends the current block- Overrides:
end
in classProcessorDefinition<ExpressionNode>
- Returns:
- the builder
-
ignoreInvalidEndpoints
Ignore the invalidate endpoint exception when try to create a producer with that endpoint- Returns:
- the builder
-
uriDelimiter
Sets the uri delimiter to use- Parameters:
uriDelimiter
- the delimiter- Returns:
- the builder
-
cacheSize
Sets the maximum size used by theProducerCache
which is used to cache and reuse producers when using this dynamic router, 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 its best to turn off 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.- Parameters:
cacheSize
- the cache size, use 0 for default cache size, or -1 to turn cache off.- Returns:
- the builder
-
cacheSize
Sets the maximum size used by theProducerCache
which is used to cache and reuse producers when using this dynamic router, 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 its best to turn off 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.- Parameters:
cacheSize
- the cache size, use 0 for default cache size, or -1 to turn cache off.- Returns:
- the builder
-