Each <ClaimProcessorDefinition> element in this element defines a Claim Processor used in this cartridge, and contains Input and Output Claims required for each implemented Claim Processor method that can be called by the framework when events occur in the Application Server.
<ClaimProcessorDefinitions>
<ClaimProcessorDefinition
Uri="tcd:Claimprocessor:example:userdetails"
ImplementationClass="com.tridion.ambientdata.ExampleClaimProcessor1"
Description="Gets user details">
<RequestStart>
<InputClaims>
<ClaimDefinition Uri="tcd:Claim:userid" />
</InputClaims>
<OutputClaims>
<ClaimDefinition Uri="tcd:Claim:username" />
<ClaimDefinition Uri="tcd:Claim:usergender" />
<ClaimDefinition Uri="tcd:Claim:userage" />
</OutputClaims>
</RequestStart>
</ClaimProcessorDefinition>
-
<ClaimProcessorDefinition>
-
The
<ClaimProcessorDefinition> element defines the <InputClaims> and <OutputClaims> required for methods implemented in the Claim Processor.
-
The
<ClaimProcessorDefinition> element has the following attributes:
Uri—the unique identifier of a Claim Processor, which must be a valid URI.
ImplementationClass—the class that implements this Claim Processor. For more information, see Implementing Claim Processors.
Description—a logical description.
ConfigProviderClass—a class that implements the ClaimProcessorConfigProvider interface to provide configuration information for this Claim Processor. When you specify a ConfigProviderClass the configuration is retrieved by calling the configuration provider class instead of being read from the cartridge XML configuration file. If you specify a ConfigProviderClass you must also specify the Uri attribute and leave the content of the <ClaimProcessorDefinition> element empty. For example:
<ClaimProcessorDefinition Uri="taf:audiencemanager:claimprocessor:contactextdetails"
ConfigProviderClass="com.tridion.ambientdata.audiencemanager.AudienceManagerProcessorConfigProvider" />
-
The
<ClaimProcessorDefinition> element can contain zero or more of the following elements which correspond to methods implemented in the Claim Processor ImplementationClass:
<RequestStart>
<RequestEnd>
<SessionStart>
The methods are events on which the Claim Processor can be called by the framework. These elements describe, for each corresponding method, the Claims it depends on (what Claims it needs to read from the Claim Store) and what Claims it writes into the Claim Store. The framework uses this information to figure out the order in which to call the Claim Processors.
-
<InputClaims>
-
The
<InputClaims> element contains <ClaimDefinition> elements that define the data loaded as input into the Claim Processor.
-
<OutputClaims>
-
The
<OutputClaims> element contains <ClaimDefinition> elements that define the data generated as output by the Claim Processor.
-
<ClaimDefinition>
-
The
<ClaimDefinition> element defines the input data retrieved from the Claim Store for a Claim Processor (the <InputClaims>), or the output data inserted into the Claim Store by the Claim Processor (the <OutputClaims>).
-
If you have defined
<ClaimDefinition> elements globally, you just need to specify the unique identifier of a Claim (the Uri) , otherwise specify Uri, Scope, Subject and Description (described above).