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, DefinitionPropertyPlaceholderConfigurer, OtherAttributesAware, org.apache.camel.NamedNode, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer

@Metadata(label="eip,transformation")
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.
Boolean	getAggregateOnException()
org.apache.camel.AggregationStrategy	getAggregationStrategy()
Boolean	getAggregationStrategyMethodAllowNull()
String	getAggregationStrategyMethodName()
String	getAggregationStrategyRef()
Integer	getCacheSize()
Boolean	getIgnoreInvalidEndpoint()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
String	getShortName()
Long	getTimeout()
PollEnrichDefinition	ignoreInvalidEndpoint() Ignore the invalidate endpoint exception when try to create a producer with that endpoint
void	setAggregateOnException(Boolean aggregateOnException)
void	setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)
void	setAggregationStrategyMethodAllowNull(Boolean aggregationStrategyMethodAllowNull)
void	setAggregationStrategyMethodName(String aggregationStrategyMethodName)
void	setAggregationStrategyRef(String aggregationStrategyRef)
void	setCacheSize(Integer cacheSize)
void	setExpression(ExpressionDefinition expression) Expression that computes the endpoint uri to use as the resource endpoint to enrich from
void	setIgnoreInvalidEndpoint(Boolean ignoreInvalidEndpoint)
void	setTimeout(Long 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, getOutputs, id, preCreateProcessor, setExpression

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

addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, attribute, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, 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, placeholder, 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, 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, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setParent, setProperty, setProperty, sort, sort, sort, 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, 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, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.model.DefinitionPropertyPlaceholderConfigurer

getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions

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.

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.

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 Long getTimeout()

setTimeout

public void setTimeout(Long timeout)

getAggregationStrategyRef

public String getAggregationStrategyRef()

setAggregationStrategyRef

public void setAggregationStrategyRef(String aggregationStrategyRef)

getAggregationStrategyMethodName

public String getAggregationStrategyMethodName()

setAggregationStrategyMethodName

public void setAggregationStrategyMethodName(String aggregationStrategyMethodName)

getAggregationStrategyMethodAllowNull

public Boolean getAggregationStrategyMethodAllowNull()

setAggregationStrategyMethodAllowNull

public void setAggregationStrategyMethodAllowNull(Boolean aggregationStrategyMethodAllowNull)

getAggregationStrategy

public org.apache.camel.AggregationStrategy getAggregationStrategy()

setAggregationStrategy

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

getAggregateOnException

public Boolean getAggregateOnException()

setAggregateOnException

public void setAggregateOnException(Boolean aggregateOnException)

getCacheSize

public Integer getCacheSize()

setCacheSize

public void setCacheSize(Integer cacheSize)

getIgnoreInvalidEndpoint

public Boolean getIgnoreInvalidEndpoint()

setIgnoreInvalidEndpoint

public void setIgnoreInvalidEndpoint(Boolean ignoreInvalidEndpoint)