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:

Block, DefinitionPropertyPlaceholderConfigurer, OtherAttributesAware, org.apache.camel.NamedNode, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer

@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

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
ClaimCheckDefinition()

Method Summary

Modifier and Type	Method and Description
ClaimCheckDefinition	aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) To use a custom AggregationStrategy instead of the default implementation.
ClaimCheckDefinition	aggregationStrategy(Supplier<org.apache.camel.AggregationStrategy> aggregationStrategy) To use a custom AggregationStrategy instead of the default implementation.
ClaimCheckDefinition	aggregationStrategyMethodName(String aggregationStrategyMethodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
ClaimCheckDefinition	aggregationStrategyRef(String aggregationStrategyRef) To use a custom AggregationStrategy instead of the default implementation.
ClaimCheckDefinition	filter(String filter) Specified a filter to control what data gets merging data back from the claim check repository.
org.apache.camel.AggregationStrategy	getAggregationStrategy()
String	getAggregationStrategyMethodName()
String	getAggregationStrategyRef()
String	getFilter()
String	getKey()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
ClaimCheckOperation	getOperation()
String	getShortName()
ClaimCheckDefinition	key(String key) To use a specific key for claim check id (for dynamic keys use simple language syntax as the key).
ClaimCheckDefinition	operation(ClaimCheckOperation operation) The claim check operation to use.
void	setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)
void	setAggregationStrategyMethodName(String aggregationStrategyMethodName)
void	setAggregationStrategyRef(String aggregationStrategyRef)
void	setFilter(String filter)
void	setKey(String key)
void	setOperation(ClaimCheckOperation operation)
String	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, attribute, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, 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, id, 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, preCreateProcessor, 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

ClaimCheckDefinition

public ClaimCheckDefinition()

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 ProcessorDefinition<ClaimCheckDefinition>

operation

public ClaimCheckDefinition operation(ClaimCheckOperation operation)

The claim check operation to use. The following operations is supported:

• Get
- Gets (does not remove) the claim check by the given key.
• GetAndRemove
- Gets and remove 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

public ClaimCheckDefinition key(String key)

To use a specific key for claim check id (for dynamic keys use simple language syntax as the key).

filter

public ClaimCheckDefinition filter(String filter)

Specified a filter to control what data gets merging 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.

The pattern uses the following rules are applied in this order:

• 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 to include 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)

For example to exclude a header name foo, and remove all headers starting with bar -header:foo,--headers:bar* Note you cannot have both include and exclude header:pattern at the same time.

aggregationStrategy

public ClaimCheckDefinition aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)

To use a custom AggregationStrategy instead of the default implementation. Notice you cannot use both custom aggregation strategy and configure data at the same time.

aggregationStrategy

public ClaimCheckDefinition aggregationStrategy(Supplier<org.apache.camel.AggregationStrategy> aggregationStrategy)

To use a custom AggregationStrategy instead of the default implementation. Notice you cannot use both custom aggregation strategy and configure data at the same time.

aggregationStrategyRef

public ClaimCheckDefinition aggregationStrategyRef(String aggregationStrategyRef)

To use a custom AggregationStrategy instead of the default implementation. Notice you cannot use both custom aggregation strategy and configure data at the same time.

aggregationStrategyMethodName

public ClaimCheckDefinition aggregationStrategyMethodName(String aggregationStrategyMethodName)

This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.

getKey

public String getKey()

setKey

public void setKey(String key)

getOperation

public ClaimCheckOperation getOperation()

setOperation

public void setOperation(ClaimCheckOperation operation)

getFilter

public String getFilter()

setFilter

public void setFilter(String filter)

getAggregationStrategyRef

public String getAggregationStrategyRef()

setAggregationStrategyRef

public void setAggregationStrategyRef(String aggregationStrategyRef)

getAggregationStrategyMethodName

public String getAggregationStrategyMethodName()

setAggregationStrategyMethodName

public void setAggregationStrategyMethodName(String aggregationStrategyMethodName)

getAggregationStrategy

public org.apache.camel.AggregationStrategy getAggregationStrategy()

setAggregationStrategy

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