Package org.apache.camel.model

Class ToDynamicDefinition

  • All Implemented Interfaces:
    org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, org.apache.camel.NamedNode, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware
    Direct Known Subclasses:
    WireTapDefinition
    @Metadata(label="eip,routing")
public class ToDynamicDefinition
extends NoOutputDefinition<ToDynamicDefinition>
    Sends the message to a dynamic endpoint

    • Constructor Detail

      • ToDynamicDefinition

        public ToDynamicDefinition()

      • ToDynamicDefinition

        public ToDynamicDefinition​(String uri)

    • Method Detail

      • getShortName

        public String getShortName()

      • uri

        public ToDynamicDefinition uri​(@AsEndpointUri
                               String uri)
        The uri of the endpoint to send to. The uri can be dynamic computed using the org.apache.camel.language.simple.SimpleLanguage expression.

      • uri

        public ToDynamicDefinition uri​(@AsEndpointUri
                               EndpointProducerBuilder endpointProducerBuilder)
        The uri of the endpoint to send to.
        Parameters:
        endpointProducerBuilder - the dynamic endpoint to send to (resolved using simple language by default)

      • pattern

        public ToDynamicDefinition pattern​(org.apache.camel.ExchangePattern pattern)
        Sets the optional ExchangePattern used to invoke this endpoint

      • pattern

        public ToDynamicDefinition pattern​(String pattern)
        Sets the optional ExchangePattern used to invoke this endpoint

      • cacheSize

        public ToDynamicDefinition cacheSize​(int cacheSize)
        Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, 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 ToDynamicDefinition cacheSize​(String cacheSize)
        Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, 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

      • ignoreInvalidEndpoint

        public ToDynamicDefinition ignoreInvalidEndpoint​(boolean ignoreInvalidEndpoint)
        Whether to ignore invalid endpoint URIs and skip sending the message.

      • ignoreInvalidEndpoint

        public ToDynamicDefinition ignoreInvalidEndpoint​(String ignoreInvalidEndpoint)
        Whether to ignore invalid endpoint URIs and skip sending the message.

      • allowOptimisedComponents

        public ToDynamicDefinition allowOptimisedComponents​(boolean allowOptimisedComponents)
        Whether to allow components to optimise toD if they are SendDynamicAware.
        Returns:
        the builder

      • allowOptimisedComponents

        public ToDynamicDefinition allowOptimisedComponents​(String allowOptimisedComponents)
        Whether to allow components to optimise toD if they are SendDynamicAware.
        Returns:
        the builder

      • autoStartComponents

        public ToDynamicDefinition autoStartComponents​(String autoStartComponents)
        Whether to auto startup components when toD is starting up.
        Returns:
        the builder

      • getUri

        public String getUri()

      • setUri

        public void setUri​(String uri)
        The uri of the endpoint to send to. The uri can be dynamic computed using the org.apache.camel.language.simple.SimpleLanguage expression.

      • setEndpointProducerBuilder

        public void setEndpointProducerBuilder​(EndpointProducerBuilder endpointProducerBuilder)

      • getPattern

        public String getPattern()

      • setPattern

        public void setPattern​(String pattern)

      • getCacheSize

        public String getCacheSize()

      • setCacheSize

        public void setCacheSize​(String cacheSize)

      • getIgnoreInvalidEndpoint

        public String getIgnoreInvalidEndpoint()

      • setIgnoreInvalidEndpoint

        public void setIgnoreInvalidEndpoint​(String ignoreInvalidEndpoint)

      • getAllowOptimisedComponents

        public String getAllowOptimisedComponents()

      • setAllowOptimisedComponents

        public void setAllowOptimisedComponents​(String allowOptimisedComponents)

      • getAutoStartComponents

        public String getAutoStartComponents()

      • setAutoStartComponents

        public void setAutoStartComponents​(String autoStartComponents)