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.NoOutputExpressionNode

org.apache.camel.model.EnrichDefinition

All Implemented Interfaces:

Block, OtherAttributesAware, NamedNode

@Metadata(label="eip,transformation")
public class EnrichDefinition
extends NoOutputExpressionNode

Enriches a message with data 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
EnrichDefinition()
EnrichDefinition(AggregationStrategy aggregationStrategy)

Method Summary

Modifier and Type	Method and Description
EnrichDefinition	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.
EnrichDefinition	aggregationStrategy(AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message.
EnrichDefinition	aggregationStrategyMethodAllowNull(boolean aggregationStrategyMethodAllowNull) If this option is false then the aggregate method is not used if there was no data to enrich.
EnrichDefinition	aggregationStrategyMethodName(String aggregationStrategyMethodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
EnrichDefinition	aggregationStrategyRef(String aggregationStrategyRef) Refers to an AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message.
EnrichDefinition	cacheSize(int cacheSize) Sets the maximum size used by the ProducerCache which is used to cache and reuse producer when uris are reused.
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
Boolean	getAggregateOnException()
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
Boolean	getShareUnitOfWork()
EnrichDefinition	ignoreInvalidEndpoint() Ignore the invalidate endpoint exception when try to create a producer with that endpoint
void	setAggregateOnException(Boolean aggregateOnException)
void	setAggregationStrategy(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	setShareUnitOfWork(Boolean shareUnitOfWork)
EnrichDefinition	shareUnitOfWork() Shares the UnitOfWork with the parent and the resource exchange.
String	toString()

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

addOutput, getOutputs, id, isOutputSupported

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

configureChild, createFilterProcessor, createPredicate, getExpression, preCreateProcessor, setOutputs

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

addInterceptStrategies, addInterceptStrategy, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, idempotentConsumer, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, makeProcessor, 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, pollEnrichRef, pollEnrichRef, pollEnrichWith, pollEnrichWith, pollEnrichWith, process, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapChannel, wrapInErrorHandler, wrapProcessor

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EnrichDefinition

public EnrichDefinition()

EnrichDefinition

public EnrichDefinition(AggregationStrategy aggregationStrategy)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

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 NamedNode

Overrides:

getLabel in class ExpressionNode

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Description copied from class: ProcessorDefinition

Override this in definition class and implement logic to create the processor based on the definition model.

Overrides:

createProcessor in class ProcessorDefinition<ExpressionNode>

Throws:

Exception

aggregationStrategy

public EnrichDefinition aggregationStrategy(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 EnrichDefinition 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 EnrichDefinition aggregationStrategyMethodName(String 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

public EnrichDefinition 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.

shareUnitOfWork

public EnrichDefinition shareUnitOfWork()

Shares the UnitOfWork with the parent and the resource exchange. Enrich will by default not share unit of work between the parent exchange and the resource exchange. This means the resource exchange has its own individual unit of work.

cacheSize

public EnrichDefinition cacheSize(int cacheSize)

Sets the maximum size used by the ProducerCache which is used to cache and reuse producer 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 EnrichDefinition 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

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 AggregationStrategy getAggregationStrategy()

setAggregationStrategy

public void setAggregationStrategy(AggregationStrategy aggregationStrategy)

getAggregateOnException

public Boolean getAggregateOnException()

setAggregateOnException

public void setAggregateOnException(Boolean aggregateOnException)

getShareUnitOfWork

public Boolean getShareUnitOfWork()

setShareUnitOfWork

public void setShareUnitOfWork(Boolean shareUnitOfWork)

getCacheSize

public Integer getCacheSize()

setCacheSize

public void setCacheSize(Integer cacheSize)

getIgnoreInvalidEndpoint

public Boolean getIgnoreInvalidEndpoint()

setIgnoreInvalidEndpoint

public void setIgnoreInvalidEndpoint(Boolean ignoreInvalidEndpoint)