Package org.apache.camel.model
Class EnrichDefinition
java.lang.Object
org.apache.camel.model.OptionalIdentifiedDefinition<Type>
org.apache.camel.model.ProcessorDefinition<ExpressionNode>
org.apache.camel.model.ExpressionNode
org.apache.camel.model.EnrichDefinition
- All Implemented Interfaces:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,AggregationStrategyAwareDefinition<EnrichDefinition>
,Block
,HasExpressionType
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasCamelContext
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@Metadata(label="eip,transformation")
public class EnrichDefinition
extends ExpressionNode
implements AggregationStrategyAwareDefinition<EnrichDefinition>
Enriches a message with data from a secondary resource
- See Also:
-
Enricher
-
Field Summary
Fields inherited from class org.apache.camel.model.ProcessorDefinition
disabled, inheritErrorHandler
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaggregateOnException
(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.aggregationStrategy
(String aggregationStrategy) Refers to an AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message.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.aggregationStrategyMethodAllowNull
(boolean aggregationStrategyMethodAllowNull) If this option is false then the aggregate method is not used if there was no data to enrich.aggregationStrategyMethodName
(String aggregationStrategyMethodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.allowOptimisedComponents
(boolean allowOptimisedComponents) Whether to allow components to optimise enricher if they areSendDynamicAware
.allowOptimisedComponents
(String allowOptimisedComponents) Whether to allow components to optimise enricher if they areSendDynamicAware
.cacheSize
(int cacheSize) Sets the maximum size used by theProducerCache
which is used to cache and reuse producer when uris are reused.Sets the maximum size used by theProducerCache
which is used to cache and reuse producer when uris are reused.org.apache.camel.AggregationStrategy
Gets the aggregation strategyIf this option is false then the aggregate method is not used for the very first aggregation.This option can be used to explicit declare the method name to use, when using beans as the AggregationStrategy.Gets a reference id to lookup the aggregation strategy from the registrygetLabel()
Returns a label to describe this node such as the expression if some kind of expression nodeIgnore the invalidate endpoint exception when try to create a producer with that endpointvoid
setAggregateOnException
(String aggregateOnException) void
setAggregationStrategy
(String aggregationStrategy) void
setAggregationStrategy
(org.apache.camel.AggregationStrategy aggregationStrategy) void
setAggregationStrategyMethodAllowNull
(String aggregationStrategyMethodAllowNull) void
setAggregationStrategyMethodName
(String aggregationStrategyMethodName) void
setAllowOptimisedComponents
(String allowOptimisedComponents) void
setCacheSize
(String cacheSize) void
setExpression
(ExpressionDefinition expression) Expression that computes the endpoint uri to use as the resource endpoint to enrich fromvoid
setIgnoreInvalidEndpoint
(String ignoreInvalidEndpoint) void
setShareUnitOfWork
(String shareUnitOfWork) Shares theUnitOfWork
with the parent and the resource exchange.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, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, 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, nodePrefixId, onCompletion, onException, onException, pausable, pausable, pausable, pausable, 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, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, 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, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
Constructor Details
-
EnrichDefinition
public EnrichDefinition() -
EnrichDefinition
public EnrichDefinition(org.apache.camel.AggregationStrategy aggregationStrategy)
-
-
Method Details
-
toString
-
getShortName
- Specified by:
getShortName
in interfaceorg.apache.camel.NamedNode
-
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 interfaceorg.apache.camel.NamedNode
- Overrides:
getLabel
in classExpressionNode
-
aggregationStrategy
public EnrichDefinition 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 interfaceAggregationStrategyAwareDefinition<EnrichDefinition>
- Parameters:
aggregationStrategy
- the aggregation strategy- Returns:
- the builder
-
aggregationStrategy
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.- Specified by:
aggregationStrategy
in interfaceAggregationStrategyAwareDefinition<EnrichDefinition>
- Parameters:
aggregationStrategy
- the aggregation strategy- Returns:
- the builder
-
aggregationStrategyMethodName
This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy. -
aggregationStrategyMethodAllowNull
public EnrichDefinition 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
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
Sets the maximum size used by theProducerCache
which is used to cache and reuse producer 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 off 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
Sets the maximum size used by theProducerCache
which is used to cache and reuse producer 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 off 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
Ignore the invalidate endpoint exception when try to create a producer with that endpoint- Returns:
- the builder
-
allowOptimisedComponents
Whether to allow components to optimise enricher if they areSendDynamicAware
.- Returns:
- the builder
-
allowOptimisedComponents
Whether to allow components to optimise enricher if they areSendDynamicAware
.- Returns:
- the builder
-
getAggregationStrategyBean
public org.apache.camel.AggregationStrategy getAggregationStrategyBean()Description copied from interface:AggregationStrategyAwareDefinition
Gets the aggregation strategy- Specified by:
getAggregationStrategyBean
in interfaceAggregationStrategyAwareDefinition<EnrichDefinition>
-
getAggregationStrategyRef
Description copied from interface:AggregationStrategyAwareDefinition
Gets a reference id to lookup the aggregation strategy from the registry- Specified by:
getAggregationStrategyRef
in interfaceAggregationStrategyAwareDefinition<EnrichDefinition>
-
setExpression
Expression that computes the endpoint uri to use as the resource endpoint to enrich from- Overrides:
setExpression
in classExpressionNode
-
getAggregationStrategy
-
setAggregationStrategy
-
setAggregationStrategy
public void setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) -
getAggregationStrategyMethodName
Description copied from interface:AggregationStrategyAwareDefinition
This option can be used to explicit declare the method name to use, when using beans as the AggregationStrategy.- Specified by:
getAggregationStrategyMethodName
in interfaceAggregationStrategyAwareDefinition<EnrichDefinition>
-
setAggregationStrategyMethodName
-
getAggregationStrategyMethodAllowNull
Description copied from interface:AggregationStrategyAwareDefinition
If this option is false then the aggregate method is not used for the very first aggregation. If this option is true then null values is used as the oldExchange (at the very first aggregation), when using beans as the AggregationStrategy.- Specified by:
getAggregationStrategyMethodAllowNull
in interfaceAggregationStrategyAwareDefinition<EnrichDefinition>
-
setAggregationStrategyMethodAllowNull
-
getAggregateOnException
-
setAggregateOnException
-
getCacheSize
-
setCacheSize
-
getIgnoreInvalidEndpoint
-
setIgnoreInvalidEndpoint
-
getAllowOptimisedComponents
-
setAllowOptimisedComponents
-