com.tridion.ambientdata

Class AmbientDataConfig

java.lang.Object

com.tridion.ambientdata.AmbientDataConfig

public final class AmbientDataConfig
extends Object

Provides configuration information to the ambient data framework.

Note: This class is to be used by the framework internally only. Clients should not use this class directly.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AMBIENT_CONFIG_FILE Reference to the main Ambient Config file.

Constructor Summary

Constructors

Constructor and Description
AmbientDataConfig()

Method Summary

Modifier and Type	Method and Description
String	getADFCookiePrefix() Gets the adf cookie prefix.
static AmbientDataConfig	getAmbientDataConfig()
List<com.tridion.configuration.Configuration>	getCartridgeConfigurations()
String	getClaimStoreProvider()
ClaimValueScope	getConfiguredClaimScope(URI claimUri)
Set<URI>	getConfiguredSessionScopeClaims()
URI	getCookieClaimName()
String	getCookieClaimNameString()
CookieConfig	getCookieConfiguration(CookieConfig.CookieType cookieType) This returns the cookie configuration for the specified cookie type.
Boolean	getDefaultCookieClaimValue()
String	getDigestKey() DigestKey returns from the configuration.
List<String>	getExcludedPaths()
Map<String,List<String>>	getForwardedClaims() Returns a singleton map where the key is the cookie name that should be used for claims forwarding and the value is the list of claims that should be forwarded.
List<String>	getGloballyAcceptedClaims() Returns a list of all claims that are allowed to be forwarded by incoming requests.
Date	getGracePeriodEndDate()
String	getInstanceID()
Set<String>	getIPAddresses()
String	getRequestValidator()
com.tridion.configuration.Configuration	getRulesConfiguration()
String	getSharedSecret()
com.tridion.configuration.Configuration	getWhiteListFilterConfiguration()
String	getWhiteListFilterCustomClassName()
boolean	isAcceptingForwardedClaims() Tells if Ambient Data Framework is enabled to receive forwarded claims.
boolean	isCookieTypePresent(CookieConfig.CookieType cookieType) This returns true if the cookie configuration is present for a specific cookie type.
boolean	isOAuthEnabled()
boolean	isWhiteListFilterConfigured()

Methods inherited from class java.lang.Object

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

Field Detail

AMBIENT_CONFIG_FILE

public static final String AMBIENT_CONFIG_FILE

Reference to the main Ambient Config file.

See Also:

Constant Field Values

Constructor Detail

AmbientDataConfig

public AmbientDataConfig()
                  throws com.tridion.configuration.ConfigurationException

Throws:

com.tridion.configuration.ConfigurationException

Method Detail

getAmbientDataConfig

public static AmbientDataConfig getAmbientDataConfig()
                                              throws com.tridion.configuration.ConfigurationException

Throws:

com.tridion.configuration.ConfigurationException

getConfiguredClaimScope

public ClaimValueScope getConfiguredClaimScope(URI claimUri)

getConfiguredSessionScopeClaims

public Set<URI> getConfiguredSessionScopeClaims()

getGracePeriodEndDate

public Date getGracePeriodEndDate()

getCookieClaimName

public URI getCookieClaimName()

getCookieClaimNameString

public String getCookieClaimNameString()

getDefaultCookieClaimValue

public Boolean getDefaultCookieClaimValue()

getRequestValidator

public String getRequestValidator()

isOAuthEnabled

public boolean isOAuthEnabled()

getSharedSecret

public String getSharedSecret()

getClaimStoreProvider

public String getClaimStoreProvider()

getInstanceID

public String getInstanceID()

getExcludedPaths

public List<String> getExcludedPaths()

getGloballyAcceptedClaims

public List<String> getGloballyAcceptedClaims()

Returns a list of all claims that are allowed to be forwarded by incoming requests. Note that this method never returns null....if there are no accepted claims we return empty list.

Returns:

a list of all claims that are allowed to be forwarded.

getForwardedClaims

public Map<String,List<String>> getForwardedClaims()

Returns a singleton map where the key is the cookie name that should be used for claims forwarding and the value is the list of claims that should be forwarded. In case no claims specified for forwarding will return empty map.

Returns:

singleton map where the key is cookie name and the value is list of claims to forward

isAcceptingForwardedClaims

public boolean isAcceptingForwardedClaims()

Tells if Ambient Data Framework is enabled to receive forwarded claims. For checking exactly what claims can be forwarded check getGloballyAcceptedClaims()

Returns:

true if we accept (some) forwarded claims.

getADFCookiePrefix

public String getADFCookiePrefix()

Gets the adf cookie prefix. This prefix is supposed to be used by clients that want to forward claims from one system to another.

Returns:

the adf cookie prefix.

getCookieConfiguration

public CookieConfig getCookieConfiguration(CookieConfig.CookieType cookieType)

This returns the cookie configuration for the specified cookie type.

Parameters:

cookieType - The cookie type to retrieve the configuration for

Returns:

The loaded cookie configuration

isCookieTypePresent

public boolean isCookieTypePresent(CookieConfig.CookieType cookieType)

This returns true if the cookie configuration is present for a specific cookie type.

Parameters:

cookieType - The cookie type to retrieve the configuration for

Returns:

True if cookie configuration is present, false if it is not.

getDigestKey

public String getDigestKey()

DigestKey returns from the configuration.

Returns:

returns if DigestKey in configuration otherwise null

getWhiteListFilterConfiguration

public com.tridion.configuration.Configuration getWhiteListFilterConfiguration()

isWhiteListFilterConfigured

public boolean isWhiteListFilterConfigured()

getIPAddresses

public Set<String> getIPAddresses()

getWhiteListFilterCustomClassName

public String getWhiteListFilterCustomClassName()

getCartridgeConfigurations

public List<com.tridion.configuration.Configuration> getCartridgeConfigurations()

getRulesConfiguration

public com.tridion.configuration.Configuration getRulesConfiguration()