Package org.apache.camel.model

Class ClaimCheckDefinition

java.lang.Object
org.apache.camel.model.OptionalIdentifiedDefinition<ClaimCheckDefinition>
org.apache.camel.model.ProcessorDefinition<ClaimCheckDefinition>
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.HasCamelContext, 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.

  • Constructor Details

    • ClaimCheckDefinition

      public ClaimCheckDefinition()

  • Method Details

    • 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 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

      public ClaimCheckDefinition operation(String 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

      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)
      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.
      The following pattern 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, 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)
      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(String 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.

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

    • getAggregationStrategyBean

      public org.apache.camel.AggregationStrategy getAggregationStrategyBean()

    • getKey

      public String getKey()

    • setKey

      public void setKey(String key)

    • getOperation

      public String getOperation()

    • setOperation

      public void setOperation(String operation)

    • getFilter

      public String getFilter()

    • setFilter

      public void setFilter(String filter)

    • getAggregationStrategy

      public String getAggregationStrategy()

    • setAggregationStrategy

      public void setAggregationStrategy(String aggregationStrategy)

    • getAggregationStrategyMethodName

      public String getAggregationStrategyMethodName()

    • setAggregationStrategyMethodName

      public void setAggregationStrategyMethodName(String aggregationStrategyMethodName)