com.tridion.ambientdata.web

Class WebClaims

java.lang.Object

com.tridion.ambientdata.web.WebClaims

public final class WebClaims
extends Object

Constants for claims that are put in the claim store when the ambient data framework is used in a web context.

The ambient data framework puts a number of claims in the claim store for each HTTP request before passing the claim store to the claim processors. The constants in this class can be used as keys to lookup those claims, for example:

 // Get the ID of the current session
 String sessionId = claimStore.get(WebClaims.SESSION_ID);
 

The following claims are put in the claim store:

Key	Type	Description
REQUEST_URI	String	URI of the current request
REQUEST_FULL_URL	String	Full URL of the current request
REQUEST_HEADERS	Map<String,String[]>	Headers of the current request
RESPONSE_HEADERS	Map<String, String>/td>	Headers of the current response
REQUEST_PARAMETERS	Map<String, String[]>	Parameters of the current request
REQUEST_COOKIES	Map<String, String>/td>	Cookies of the current request
SERVER_VARIABLES	Map<String, String>	Server variables
SESSION_ID	String	ID of the current session
TRACKING_ID	String	Identifier that's persistent over sessions
SESSION_ATTRIBUTES	Map<String, Object>	Attributes of the current session
DEFAULT_COOKIE_CLAIM	Boolean	Default name of the cookie generation claim

Field Summary

Fields

Modifier and Type	Field and Description
static URI	COOKIE_FORWARDING_CLAIM Key for the cookie forwarding claim.
static URI	DEFAULT_COOKIE_CLAIM Key for the claim that contains the default name of the cookie generation claim Boolean (read-only).
static URI	ISH_USER_CONDITIONS Key for user conditions before enhancing with additional conditions from publication.
static URI	ISH_USER_CONDITIONS_MERGED Key for user conditions after enhancing with additional conditions from publication.
static URI	ISH_USER_CONDITIONS_PARSED Key for user conditions after enhancing with additional conditions from publication.
static String	READ_WRITE_URI Key that controls the graphql mutation security.
static URI	REQUEST_COOKIES Key for the claim that contains the request cookies as a Map<String, String> (read-only).
static URI	REQUEST_FULL_URL Key for the claim that contains the full URL of the current request (as a string) (read-only).
static URI	REQUEST_HEADERS Key for the claim that contains the headers of the current request as a Map<String, String[]>(read-only).
static URI	REQUEST_PARAMETERS Key for the claim that contains the parameters of the current request.
static URI	REQUEST_URI Key for the claim that contains the URI of the current request (as a string) (read-only).
static URI	RESPONSE_HEADERS Key for the claim that contains the headers of the current response.
static URI	SERVER_VARIABLES Key for the claim that contains the server variables of the current request.
static URI	SESSION_ATTRIBUTES Key for the claim that contains the attributes of the current session as a Map<String, Object> (read-only).
static URI	SESSION_ID Key for the claim that contains the ID of the current session (as a string) (read-only).
static URI	TCDL_RENDER_BINARY_LINK_PREFIX Key that controlls how TCDL processor should render link's.
static URI	TCDL_RENDER_LINK_PREFIX Key that controlls how TCDL processor should render link's.
static URI	TCDL_RENDER_RELATIVE_LINK Key that controlls how TCDL processor should render link's.
static URI	TRACKING_ID Key for the claim that contains the ID stored in the persistent tracking cookie (as a string) (read-only).

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REQUEST_URI

public static final URI REQUEST_URI

Key for the claim that contains the URI of the current request (as a string) (read-only).

REQUEST_FULL_URL

public static final URI REQUEST_FULL_URL

Key for the claim that contains the full URL of the current request (as a string) (read-only).

REQUEST_HEADERS

public static final URI REQUEST_HEADERS

Key for the claim that contains the headers of the current request as a Map<String, String[]>(read-only).

RESPONSE_HEADERS

public static final URI RESPONSE_HEADERS

Key for the claim that contains the headers of the current response. as a Map<String, String>.(read-only)

REQUEST_PARAMETERS

public static final URI REQUEST_PARAMETERS

Key for the claim that contains the parameters of the current request. as a Map<String, String[]>(read-only).

REQUEST_COOKIES

public static final URI REQUEST_COOKIES

Key for the claim that contains the request cookies as a Map<String, String> (read-only).

SERVER_VARIABLES

public static final URI SERVER_VARIABLES

Key for the claim that contains the server variables of the current request. as a Map<String, String> (read-only).

SESSION_ID

public static final URI SESSION_ID

Key for the claim that contains the ID of the current session (as a string) (read-only).

TRACKING_ID

public static final URI TRACKING_ID

Key for the claim that contains the ID stored in the persistent tracking cookie (as a string) (read-only).

SESSION_ATTRIBUTES

public static final URI SESSION_ATTRIBUTES

Key for the claim that contains the attributes of the current session as a Map<String, Object> (read-only).

DEFAULT_COOKIE_CLAIM

public static final URI DEFAULT_COOKIE_CLAIM

Key for the claim that contains the default name of the cookie generation claim Boolean (read-only).

COOKIE_FORWARDING_CLAIM

public static final URI COOKIE_FORWARDING_CLAIM

Key for the cookie forwarding claim.

ISH_USER_CONDITIONS

public static final URI ISH_USER_CONDITIONS

Key for user conditions before enhancing with additional conditions from publication.

ISH_USER_CONDITIONS_PARSED

public static final URI ISH_USER_CONDITIONS_PARSED

Key for user conditions after enhancing with additional conditions from publication. This is static server side claim.

ISH_USER_CONDITIONS_MERGED

public static final URI ISH_USER_CONDITIONS_MERGED

Key for user conditions after enhancing with additional conditions from publication. Holds JSON String that is passed then on client side.

TCDL_RENDER_RELATIVE_LINK

public static final URI TCDL_RENDER_RELATIVE_LINK

Key that controlls how TCDL processor should render link's. Use true value to override the linking configuration and return relative links.

TCDL_RENDER_LINK_PREFIX

public static final URI TCDL_RENDER_LINK_PREFIX

Key that controlls how TCDL processor should render link's. If TCDL_RENDER_RELATIVE_LINK is set to false and this claim has a value, then the value will be prepended to the URL despite on the linking configuration. Supported for Docs only.

TCDL_RENDER_BINARY_LINK_PREFIX

public static final URI TCDL_RENDER_BINARY_LINK_PREFIX

Key that controlls how TCDL processor should render link's. If TCDL_RENDER_RELATIVE_LINK is set to false and this claim has a value, then the value will be prepended to the binary URL despite on the linking configuration. Supported for Docs only.

READ_WRITE_URI

public static final String READ_WRITE_URI

Key that controls the graphql mutation security.

See Also:

Constant Field Values