Package org.apache.camel.model

Class DynamicRouterDefinition<Type extends ProcessorDefinition<Type>>

  • All Implemented Interfaces:
    org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, HasExpressionType, org.apache.camel.NamedNode, 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

    • Constructor Detail

      • DynamicRouterDefinition

        public DynamicRouterDefinition()

      • DynamicRouterDefinition

        public DynamicRouterDefinition​(org.apache.camel.Expression expression)

    • Method Detail

      • getShortName

        public String getShortName()

      • 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 org.apache.camel.NamedNode
        Overrides:
        getLabel in class ExpressionNode

      • setExpression

        public void setExpression​(ExpressionDefinition expression)
        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 class ExpressionNode

      • setUriDelimiter

        public void setUriDelimiter​(String uriDelimiter)

      • getUriDelimiter

        public String getUriDelimiter()

      • setIgnoreInvalidEndpoints

        public void setIgnoreInvalidEndpoints​(String ignoreInvalidEndpoints)

      • getIgnoreInvalidEndpoints

        public String getIgnoreInvalidEndpoints()

      • getCacheSize

        public String getCacheSize()

      • setCacheSize

        public void setCacheSize​(String cacheSize)

      • ignoreInvalidEndpoints

        public DynamicRouterDefinition<Type> ignoreInvalidEndpoints()
        Ignore the invalidate endpoint exception when try to create a producer with that endpoint
        Returns:
        the builder

      • uriDelimiter

        public DynamicRouterDefinition<Type> uriDelimiter​(String uriDelimiter)
        Sets the uri delimiter to use
        Parameters:
        uriDelimiter - the delimiter
        Returns:
        the builder

      • cacheSize

        public DynamicRouterDefinition<Type> cacheSize​(int cacheSize)
        Sets the maximum size used by the ProducerCache 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 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.
        Parameters:
        cacheSize - the cache size, use 0 for default cache size, or -1 to turn cache off.
        Returns:
        the builder

      • cacheSize

        public DynamicRouterDefinition<Type> cacheSize​(String cacheSize)
        Sets the maximum size used by the ProducerCache 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 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.
        Parameters:
        cacheSize - the cache size, use 0 for default cache size, or -1 to turn cache off.
        Returns:
        the builder