org.apache.camel.model

Class PollEnrichDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<ExpressionNode>

org.apache.camel.model.ExpressionNode

org.apache.camel.model.PollEnrichDefinition

All Implemented Interfaces:

Block, HasExpressionType, org.apache.camel.NamedNode, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

@Metadata(label="eip,routing")
public class PollEnrichDefinition
extends ExpressionNode

Enriches messages with data polled from a secondary resource

See Also:

Enricher

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
PollEnrichDefinition()
PollEnrichDefinition(org.apache.camel.AggregationStrategy aggregationStrategy, long timeout)

Method Summary

Modifier and Type	Method and Description
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.
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.
PollEnrichDefinition	aggregationStrategy(Supplier<org.apache.camel.AggregationStrategy> aggregationStrategy) Sets the AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message.
PollEnrichDefinition	aggregationStrategyMethodAllowNull(boolean aggregationStrategyMethodAllowNull) If this option is false then the aggregate method is not used if there was no data to enrich.
PollEnrichDefinition	aggregationStrategyMethodName(String aggregationStrategyMethodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
PollEnrichDefinition	aggregationStrategyRef(String aggregationStrategyRef) Refers to an AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message.
PollEnrichDefinition	cacheSize(int cacheSize) Sets the maximum size used by the ConsumerCache which is used to cache and reuse consumers when uris are reused.
PollEnrichDefinition	cacheSize(String cacheSize) Sets the maximum size used by the ConsumerCache which is used to cache and reuse consumers when uris are reused.
String	getAggregateOnException()
org.apache.camel.AggregationStrategy	getAggregationStrategy()
String	getAggregationStrategyMethodAllowNull()
String	getAggregationStrategyMethodName()
String	getAggregationStrategyRef()
String	getCacheSize()
String	getIgnoreInvalidEndpoint()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
String	getShortName()
String	getTimeout()
PollEnrichDefinition	ignoreInvalidEndpoint() Ignore the invalidate endpoint exception when try to create a producer with that endpoint
void	setAggregateOnException(String aggregateOnException)
void	setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)
void	setAggregationStrategyMethodAllowNull(String aggregationStrategyMethodAllowNull)
void	setAggregationStrategyMethodName(String aggregationStrategyMethodName)
void	setAggregationStrategyRef(String aggregationStrategyRef)
void	setCacheSize(String cacheSize)
void	setExpression(ExpressionDefinition expression) Expression that computes the endpoint uri to use as the resource endpoint to enrich from
void	setIgnoreInvalidEndpoint(String ignoreInvalidEndpoint)
void	setTimeout(String timeout)
PollEnrichDefinition	timeout(long timeout) Timeout in millis when polling from the external service.
String	toString()

Methods inherited from class org.apache.camel.model.ExpressionNode

configureChild, getExpression, getExpressionType, getOutputs, 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, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoTry, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getParent, 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, 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, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, 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, validate, validate, validate, wireTap, wireTap, wireTap

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCustomId, getDescription, getDescriptionText, getId, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setGeneratedId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PollEnrichDefinition

public PollEnrichDefinition()

PollEnrichDefinition

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

Method Detail

toString

public String toString()

Overrides:

toString in class Object

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

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.

aggregationStrategy

public PollEnrichDefinition aggregationStrategy(Supplier<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.

aggregationStrategyRef

public PollEnrichDefinition aggregationStrategyRef(String aggregationStrategyRef)

Refers to an 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.

The value can either refer to a bean to lookup, or to lookup a singleton bean by its type, or to create a new bean:

• Lookup bean - This is the default behavior to lookup an existing bean by the bean id (value)
• reference by type - Values can refer to singleton beans by their type in the registry by prefixing with #type: syntax, eg #type:com.foo.MyClassType
• reference new class - Values can refer to creating new beans by their class name by prefixing with #class, eg #class:com.foo.MyClassType. The class is created using a default no-arg constructor, however if you need to create the instance via a factory method then you specify the method as shown: #class:com.foo.MyClassType#myFactoryMethod. And if the factory method requires parameters they can be specified as follows: #class:com.foo.MyClassType#myFactoryMethod('Hello World', 5, true). Or if you need to create the instance via constructor parameters then you can specify the parameters as shown: #class:com.foo.MyClass('Hello World', 5, true)
.

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

setExpression

public void setExpression(ExpressionDefinition expression)

Expression that computes the endpoint uri to use as the resource endpoint to enrich from

Overrides:

setExpression in class ExpressionNode

getTimeout

public String getTimeout()

setTimeout

public void setTimeout(String timeout)

getAggregationStrategyRef

public String getAggregationStrategyRef()

setAggregationStrategyRef

public void setAggregationStrategyRef(String aggregationStrategyRef)

getAggregationStrategyMethodName

public String getAggregationStrategyMethodName()

setAggregationStrategyMethodName

public void setAggregationStrategyMethodName(String aggregationStrategyMethodName)

getAggregationStrategyMethodAllowNull

public String getAggregationStrategyMethodAllowNull()

setAggregationStrategyMethodAllowNull

public void setAggregationStrategyMethodAllowNull(String aggregationStrategyMethodAllowNull)

getAggregationStrategy

public org.apache.camel.AggregationStrategy getAggregationStrategy()

setAggregationStrategy

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

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)