Ambient Data Framework system diagram
You add an Ambient Data Framework client (a servlet filter) to your Web application. The client communicates with the Ambient Data Framework service, available through a Content Delivery microservice (typically the Content Service). The Ambient Data Framework service combines Claims, Claim Processors and Cartridges.
| Item | Description |
|---|---|
| Ambient Data Framework client | A servlet that uses the accompanying Ambient Data Framework configuration file to connect to the Ambient Data Framework service, contained within a microservice container (the client determines which one to connect to). The Ambient Data Framework configuration file in the servlet should not contain Cartridge definitions: Content Delivery ignores them. |
| Ambient Data Framework service | The service that actually processes Input Claims coming from the client and serves Output Claims back to the client. The Ambient Data Framework configuration file in the service contains definitions for the Cartridges that are set up in the appropriate Content Delivery microservice, which can be the Content Service, the Session Preview Web service, or both, depending on the Cartridge. |
| Cartridges | JAR files, each containing a set of related Claim Processors that perform a certain task. |
| Ambient Data Framework Cartridge configuration file | An XML configuration file that wires Claim Processors together and defines the input and Output Claims required by the Claim Processors. |
| Claim | A piece of information the framework deals with: an Input Claim is the input data required by a Claim Processor and an Output Claim the resulting output data. Claims are stored in the Claim Store. |
| Claim Processor | A piece of Java code that puts Claims into the Claim Store and converts Input Claims to Output Claims. A Claim Processor responds to request or session events called by the framework. |
The runtime components of the Ambient Data Framework are instantiated when the application server is processing HTTP requests from the user's browser. These components perform the framework's part of processing the HTTP request which involves looking up the Claim Store in the HTTP session that is associated with the request and calling the Claim Processors in the configured cartridges. It then examines the input and Output Claims of each of the Claim Processors in the cartridges and sorts the Claim Processors so that they are executed in the order necessary to satisfy the dependencies between the Claim Processors.