com.tridion.ambientdata

Class AmbientDataContext

java.lang.Object

com.tridion.ambientdata.AmbientDataContext

Direct Known Subclasses:

WebContext

public abstract class AmbientDataContext
extends Object

The ambient data context.

You can use this to get current state information from the ambient data framework, for example to get the current claim store:

 ClaimStore claimStore = AmbientDataContext.getCurrentClaimStore();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AmbientDataContext()
protected	AmbientDataContext(com.tridion.ambientdata.configuration.CartridgeCategory cartridgeCategory)

Method Summary

Modifier and Type	Method and Description
static AmbientDataConfig	getAmbientDataConfig() Loads the AmbientDataConfig from the context.
com.tridion.ambientdata.configuration.CartridgeCategory	getCartridgeCategory() Gets configured cartridge category.
static AmbientDataContext	getContext() Gets the current ambient data context.
static ClaimStore	getCurrentClaimStore() Gets the current claim store.
protected abstract ClaimStore	getCurrentClaimStoreImpl() Gets the current claim store, to be implemented by subclasses.
static void	setContext(AmbientDataContext context) Sets the current ambient data context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AmbientDataContext

protected AmbientDataContext()

AmbientDataContext

protected AmbientDataContext(com.tridion.ambientdata.configuration.CartridgeCategory cartridgeCategory)

Method Detail

getCartridgeCategory

public com.tridion.ambientdata.configuration.CartridgeCategory getCartridgeCategory()

Gets configured cartridge category.

Returns:

CartridgeCategory.

getContext

public static AmbientDataContext getContext()

Gets the current ambient data context.

Returns:

The current ambient data context.

setContext

public static void setContext(AmbientDataContext context)

Sets the current ambient data context. This method is called internally by the framework, clients should not normally call this method.

Parameters:

context - The AmbientDataContext to set as the current context.

getCurrentClaimStore

public static ClaimStore getCurrentClaimStore()

Gets the current claim store.

Returns:

The current claim store.

getAmbientDataConfig

public static AmbientDataConfig getAmbientDataConfig()

Loads the AmbientDataConfig from the context.

Returns:

AmbientDataConfig

getCurrentClaimStoreImpl

protected abstract ClaimStore getCurrentClaimStoreImpl()

Gets the current claim store, to be implemented by subclasses.

Returns:

The current claim store.