Documentation Center

Ambient Data Framework Java API

The Ambient Data Framework Java API is documented in its Javadoc. This topic lists the main classes and interfaces of the API.

ClassDescription
AmbientDataServletFilterFilter that is called by the application server when request and session events occur.
AmbientDataContextProvides access to the current Claim Store object.
AbstractClaimProcessorImplementation of a Claim Processor.
ClaimStoreContainer that holds the current values of a set of Claims.
ClaimProcessorDefinitionDefinition configuration of a Claim Processor.
ClaimDefinitionDefinition of a Claim type.
ClaimProcessorMethodSpecSpecification of the Input and Output Claims of a Claim Processor method.
InterfaceDescription
ClaimProcessorClaim Processor, called when events happen in the application server.
ClaimProcessorConfigProviderConfiguration provider for Claim Processors.
AmbientDataServletFilter

The AmbientDataServletFilter is called by the application server when certain events happen, such as when a request is received, a request has been handled and a new session has been created.

You need to configure the AmbientDataServletFilter in the web.xml deployment descriptor.

AmbientDataContext

The AmbientDataContext class provides access to the Claim Store. Get the Claim Store object by calling AmbientDataContext.getCurrentClaimStore() method which you can then use to get and set Claim values.

AbstractClaimProcessor

The AbstractClaimProcessor class implements a Claim Processor that produces or transforms the values of Claims in a Claim Store, or reads data from external systems such as Audience Manager.

You extend the AbstractClaimProcessor class to add application-specific logic to the system. For more information, see Claim.

ClaimStore

ClaimStore represents a repository in which the current values of Claims are stored. There is a ClaimStore for each visitor session. The engine stores the Claim Store in the session and retrieves it from the session when needed.

You implement the ClaimStore class to put values in the Claim Store onto your Web page.

ClaimProcessorDefinition

A ClaimProcessorDefinition holds two sets of Claim definitions, one for the input Claims of the Claim Processor and one for the Output Claims. The framework uses this information to discover dependencies between Claim Processors; if one Claim Processor outputs Claim type A and another has Claim type A as its input, then the first one will be executed before the second one. Claim Processors are organized into cartridges: the CartridgeDefinition class contains a set of Claim Processor definitions.

ClaimDefinition

Claims (as well as Claim Processors and cartridges) are identified by a URI and all have a description field in which you can store a human-readable description. You can also change the scope of the Claim so that it is removed when the session ends rather than when the request ends (default behavior). The Default Claims that SDL Tridion Sites ships with already have their own default scope value set.

ClaimProcessorMethodSpec

Specification of the input and output Claims of a Claim Processor method.

ClaimProcessor

The ClaimProcessor interface represents a processor that produces or transforms the values of Claims in a Claim Store, or reads data from external systems such as Audience Manager.

You implement the ClaimProcessor interface to add application-specific logic to the system. For more information, see Claim.

ClaimProcessorConfigProvider

The ClaimProcessorConfigProvider interface allows you to configure a Claim Processor programmatically instead of statically in the cartridge XML configuration file.

Create a class that implements this interface and define the Input and Output Claims required by the Claim Processor and the event on which the Claim Processor is triggered. You then need to specify the name of the class in the configuration file using the ConfigProviderClass attribute on the <ClaimProcessorDefinition> element. For more information, see Defining a cartridge XML configuration file.