Documentation Center

ClaimDefinitions element

The <ClaimDefinition> is an optional element that defines the Claims that the Claim Processors in the cartridge deal with so that you can refer to a Claim in the <ClaimProcessorDefinition> element by specifying the URI of the Claim instead of specifying it in full.

<ClaimDefinitions>
	<ClaimDefinition Uri="tcd:Claim:userid" Scope="SESSION" Description="The user's unique identifier." />
	<ClaimDefinition Uri="tcd:Claim:username" Scope="SESSION" Description="The user's full name." />
	<ClaimDefinition Uri="tcd:Claim:usergender" Scope="SESSION" Description="The user's sex (M or F)." />
	<ClaimDefinition Uri="tcd:Claim:userage" Scope="SESSION" Description="The user's age in years." />
</ClaimDefinitions>
<ClaimDefinition>
The <ClaimDefinition> element defines a single Claim that can be used by a Claim Processor. The <ClaimDefinition> element has the following attributes:
Uri

The unique identifier of a Claim, which must be a valid URI.

Scope

(optional, defaults to REQUEST if omitted) The scope of a Claim: SESSION or REQUEST. If set to SESSION, Claims are removed when the session ends; if set to REQUEST, Claims are removed after onRequestEnd() has been called. This setting also affects forwarded Claims. The Default Claims that SDL Tridion ships with already have their own default scope value set.

If you attempt to use the Ambient Data Framework API ClaimStore.put() method to set the scope of a Claim that already has a Claim Definition, the Ambient Data Framework raises an exception.

Subject
(optional) a URI that identifies the subject that a Claim pertains to (a logical grouping of Claims)
Description
a logical description