Package org.apache.camel.model
Class ClaimCheckDefinition
java.lang.Object
org.apache.camel.model.OptionalIdentifiedDefinition<Type>
org.apache.camel.model.ProcessorDefinition<Type>
org.apache.camel.model.NoOutputDefinition<ClaimCheckDefinition>
org.apache.camel.model.ClaimCheckDefinition
- All Implemented Interfaces:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,Block
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@Metadata(label="eip,routing")
public class ClaimCheckDefinition
extends NoOutputDefinition<ClaimCheckDefinition>
The Claim Check EIP allows you to replace message content with a claim check (a unique key), which can be used to
retrieve the message content at a later time.
-
Field Summary
Fields inherited from class org.apache.camel.model.ProcessorDefinition
disabled, inheritErrorHandler
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaggregationStrategy
(String aggregationStrategy) To use a customAggregationStrategy
instead of the default implementation.aggregationStrategy
(org.apache.camel.AggregationStrategy aggregationStrategy) To use a customAggregationStrategy
instead of the default implementation.aggregationStrategyMethodName
(String aggregationStrategyMethodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.Specify a filter to control what data gets merged data back from the claim check repository.org.apache.camel.AggregationStrategy
getKey()
getLabel()
Returns a label to describe this node such as the expression if some kind of expression nodeTo use a specific key for claim check id (for dynamic keys use simple language syntax as the key).The claim check operation to use.operation
(ClaimCheckOperation operation) The claim check operation to use.void
setAggregationStrategy
(String aggregationStrategy) void
setAggregationStrategyMethodName
(String aggregationStrategyMethodName) void
void
void
setOperation
(String operation) toString()
Methods inherited from class org.apache.camel.model.NoOutputDefinition
getOutputs
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, configureChild, 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, id, 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, nodePrefixId, onCompletion, onException, onException, pausable, pausable, pausable, pausable, 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, preCreateProcessor, 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, 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, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, 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, description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
Constructor Details
-
ClaimCheckDefinition
public ClaimCheckDefinition()
-
-
Method Details
-
toString
-
getShortName
-
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 classProcessorDefinition<ClaimCheckDefinition>
-
operation
The claim check operation to use. The following operations are supported:- Get - Gets (does not remove) the claim check by the given key.
- GetAndRemove - Gets and removes the claim check by the given key.
- Set - Sets a new (will override if key already exists) claim check with the given key.
- Push - Sets a new claim check on the stack (does not use key).
- Pop - Gets the latest claim check from the stack (does not use key).
-
operation
The claim check operation to use. The following operations are supported:- Get - Gets (does not remove) the claim check by the given key.
- GetAndRemove - Gets and removes the claim check by the given key.
- Set - Sets a new (will override if key already exists) claim check with the given key.
- Push - Sets a new claim check on the stack (does not use key).
- Pop - Gets the latest claim check from the stack (does not use key).
-
key
To use a specific key for claim check id (for dynamic keys use simple language syntax as the key). -
filter
Specify a filter to control what data gets merged data back from the claim check repository. The following syntax is supported:- body - to aggregate the message body
- attachments - to aggregate all the message attachments
- headers - to aggregate all the message headers
- header:pattern - to aggregate all the message headers that matches the pattern.
- exact match, returns true
- wildcard match (pattern ends with a * and the name starts with the pattern), returns true
- regular expression match, returns true
- otherwise returns false
You can specify multiple rules separated by comma. For example, the following includes the message body and all headers starting with foo: body,header:foo*. The syntax supports the following prefixes which can be used to specify include,exclude, or remove
- + - to include (which is the default mode)
- - - to exclude (exclude takes precedence over include)
- -- - to remove (remove takes precedence)
-
aggregationStrategy
public ClaimCheckDefinition aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) To use a customAggregationStrategy
instead of the default implementation. Notice you cannot use both custom aggregation strategy and configure data at the same time. -
aggregationStrategy
To use a customAggregationStrategy
instead of the default implementation. Notice you cannot use both custom aggregation strategy and configure data at the same time. -
aggregationStrategyMethodName
This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy. -
getAggregationStrategyBean
public org.apache.camel.AggregationStrategy getAggregationStrategyBean() -
getKey
-
setKey
-
getOperation
-
setOperation
-
getFilter
-
setFilter
-
getAggregationStrategy
-
setAggregationStrategy
-
getAggregationStrategyMethodName
-
setAggregationStrategyMethodName
-