Package org.apache.camel.model

Class PollEnrichDefinition

    • Constructor Detail

      • PollEnrichDefinition

        public PollEnrichDefinition()

      • PollEnrichDefinition

        public PollEnrichDefinition​(org.apache.camel.AggregationStrategy aggregationStrategy,
                            long timeout)

    • Method Detail

      • getShortName

        public String getShortName()
        Specified by:
        getShortName in interface org.apache.camel.NamedNode

      • 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

      • timeout

        public PollEnrichDefinition timeout​(long timeout)
        Timeout in millis when polling from the external service.

        The timeout has influence about the poll enrich behavior. It basically operations in three different modes:

        • negative value - Waits until a message is available and then returns it. Warning that this method could block indefinitely if no messages are available.
        • 0 - Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet.
        • positive value - Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available. Returns null if timed out
        The default value is -1 and therefore the method could block indefinitely, and therefore its recommended to use a timeout value

      • aggregationStrategy

        public PollEnrichDefinition aggregationStrategy​(org.apache.camel.AggregationStrategy aggregationStrategy)
        Sets the AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message. By default Camel will use the reply from the external service as outgoing message.
        Specified by:
        aggregationStrategy in interface AggregationStrategyAwareDefinition<PollEnrichDefinition>
        Parameters:
        aggregationStrategy - the aggregation strategy
        Returns:
        the builder

      • aggregationStrategyMethodName

        public PollEnrichDefinition aggregationStrategyMethodName​(String aggregationStrategyMethodName)
        This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.

      • aggregationStrategyMethodAllowNull

        public PollEnrichDefinition aggregationStrategyMethodAllowNull​(boolean aggregationStrategyMethodAllowNull)
        If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy.

      • aggregateOnException

        public PollEnrichDefinition aggregateOnException​(boolean aggregateOnException)
        If this option is false then the aggregate method is not used if there was an exception thrown while trying to retrieve the data to enrich from the resource. Setting this option to true allows end users to control what to do if there was an exception in the aggregate method. For example to suppress the exception or set a custom message body etc.

      • cacheSize

        public PollEnrichDefinition cacheSize​(int cacheSize)
        Sets the maximum size used by the ConsumerCache which is used to cache and reuse consumers 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 PollEnrichDefinition cacheSize​(String cacheSize)
        Sets the maximum size used by the ConsumerCache which is used to cache and reuse consumers 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 PollEnrichDefinition ignoreInvalidEndpoint()
        Ignore the invalidate endpoint exception when try to create a producer with that endpoint
        Returns:
        the builder

      • getTimeout

        public String getTimeout()

      • setTimeout

        public void setTimeout​(String timeout)

      • getAggregationStrategy

        public String getAggregationStrategy()

      • setAggregationStrategy

        public void setAggregationStrategy​(String aggregationStrategy)

      • setAggregationStrategy

        public void setAggregationStrategy​(org.apache.camel.AggregationStrategy aggregationStrategy)

      • setAggregationStrategyMethodName

        public void setAggregationStrategyMethodName​(String aggregationStrategyMethodName)

      • setAggregationStrategyMethodAllowNull

        public void setAggregationStrategyMethodAllowNull​(String aggregationStrategyMethodAllowNull)

      • getAggregateOnException

        public String getAggregateOnException()

      • setAggregateOnException

        public void setAggregateOnException​(String aggregateOnException)

      • getCacheSize

        public String getCacheSize()

      • setCacheSize

        public void setCacheSize​(String cacheSize)

      • getIgnoreInvalidEndpoint

        public String getIgnoreInvalidEndpoint()

      • setIgnoreInvalidEndpoint

        public void setIgnoreInvalidEndpoint​(String ignoreInvalidEndpoint)