com.tridion.ambientdata.claimstore

Class DefaultClaimStore

java.lang.Object

com.tridion.ambientdata.claimstore.DefaultClaimStore

All Implemented Interfaces:

ClaimStore, Serializable

Direct Known Subclasses:

JavaClaimStore

public class DefaultClaimStore
extends Object
implements Serializable, ClaimStore

Default container that holds the current values of a set of claims.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultClaimStore() Constructor, creates and initializes a new ClaimStore.
protected	DefaultClaimStore(Map<URI,Object> values, Set<URI> readOnlyFields) Deprecated. This constructor should not be used, as it copies only part of the state of the object. It clears all immutable fields and ad-hoc claim scopes.
protected	DefaultClaimStore(Map<URI,Object> values, Set<URI> readOnlyFields, Set<URI> immutableFields) Deprecated. This constructor should not be used, as it copies only part of the state of the object. It clears all and ad-hoc claim scopes.
protected	DefaultClaimStore(Map<URI,Object> values, Set<URI> readOnlyFields, Set<URI> immutableFields, Map<URI,ClaimValueScope> adHocClaimScopesRef) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearImmutable() Empties the immutable set of claims.
void	clearReadOnly() Empties the read only set of claims.
DefaultClaimStore	clone() Creates and returns a copy of this object.
boolean	contains(URI claimUri) Returns true if the claim store contains a claim, false otherwise.
Object	get(URI claimUri) Gets the value of a claim from the claim store.
<T> T	get(URI claimUri, Class<T> cls) Gets the value of a claim from the claim store.
Map<URI,ClaimValueScope>	getAdHocClaimScopes()
Map<URI,Object>	getAll() Gets a map containing all the claim values in the claim store.
Set<URI>	getAllImmutableClaims() Gets a set containing all the immutable claim in the claim store.
Set<URI>	getAllReadOnlyClaims() Gets a set containing all the read only claim in the claim store.
Map<URI,Object>	getClaimValues() Current values of claims.
ClaimValueScope	getConfiguredClaimScope(URI claimUri) Returns the configured scope of the claim identified by URI.
Set<URI>	getImmutable()
Set<URI>	getReadOnly() Claims in this set are read-only.
boolean	isImmutable(URI claimUri) Returns true if the claim is immutable, false otherwise.
boolean	isReadOnly(URI claimUri) Returns true if the claim is read-only, false otherwise.
boolean	isSessionScopedClaim(ClaimValueScope scope) Returns true if given scope lives during session.
void	put(URI claimUri, Object value) Puts the value of a claim in the claim store.
void	put(URI claimUri, Object value, boolean writeOnce) Deprecated.
void	put(URI claimUri, Object value, ClaimType claimType) Puts the value of a claim in the claim store.
void	put(URI claimUri, Object value, ClaimType claimType, ClaimValueScope claimScope) Puts the value of a claim in the claim store, under the following conditions.
void	put(URI claimUri, Object value, ClaimValueScope claimScope) Puts the value of a claim in the claim store, under the following conditions.
void	remove(URI claimUri) Removes the value of a claim from the claim store.
void	removeRequestScopedClaims() Goes through the claims in the ClaimStore and deletes the ones that don't have a configured scope for SESSION.
void	setImmutableClaims(Collection<URI> immutableClaims) Set a collection of claim as immutable.
void	setReadOnlyClaims(Collection<URI> readOnlyClaims) Set a collection of claim as read-only.
void	shrinkStaticClaims() Removes all static-scoped claims from claim value map.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultClaimStore

public DefaultClaimStore()

Constructor, creates and initializes a new ClaimStore. method is called internally by the framework, clients should not normally create a claim store directly.

DefaultClaimStore

@Deprecated
protected DefaultClaimStore(Map<URI,Object> values,
                                         Set<URI> readOnlyFields)

Deprecated. This constructor should not be used, as it copies only part of the state of the object. It clears all immutable fields and ad-hoc claim scopes.

Constructor.

Parameters:

values - Values.

readOnlyFields - Read-only fields.

DefaultClaimStore

@Deprecated
protected DefaultClaimStore(Map<URI,Object> values,
                                         Set<URI> readOnlyFields,
                                         Set<URI> immutableFields)

Deprecated. This constructor should not be used, as it copies only part of the state of the object. It clears all and ad-hoc claim scopes.

Constructor.

Parameters:

values - Values.

readOnlyFields - Read-only fields.

immutableFields - Immutable fields.

DefaultClaimStore

protected DefaultClaimStore(Map<URI,Object> values,
                            Set<URI> readOnlyFields,
                            Set<URI> immutableFields,
                            Map<URI,ClaimValueScope> adHocClaimScopesRef)

Constructor. This is meant to be used by the clone() method.

Parameters:

values - Values.

readOnlyFields - Read-only fields.

immutableFields - Immutable fields.

adHocClaimScopesRef - Ad-hoc claim scopes.

Method Detail

get

public Object get(URI claimUri)

Description copied from interface: ClaimStore

Gets the value of a claim from the claim store. You should prefer to use ClaimStore.get(java.net.URI, Class) instead of this method, as it doesn't require you to cast the result.

Specified by:

get in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

Returns:

The current value of the claim or null if this claim has no current value.

get

public <T> T get(URI claimUri,
                 Class<T> cls)

Description copied from interface: ClaimStore

Gets the value of a claim from the claim store.

Specified by:

get in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

cls - The expected type of the claim value.

Returns:

The current value of the claim or null if this claim has no current value.

getAll

public Map<URI,Object> getAll()

Description copied from interface: ClaimStore

Gets a map containing all the claim values in the claim store.

Specified by:

getAll in interface ClaimStore

Returns:

A read-only Map that maps claim URIs to claim values.

getAllReadOnlyClaims

public Set<URI> getAllReadOnlyClaims()

Description copied from interface: ClaimStore

Gets a set containing all the read only claim in the claim store.

Specified by:

getAllReadOnlyClaims in interface ClaimStore

Returns:

A read-only Map that maps claim URIs to claim values.

getAllImmutableClaims

public Set<URI> getAllImmutableClaims()

Description copied from interface: ClaimStore

Gets a set containing all the immutable claim in the claim store.

Specified by:

getAllImmutableClaims in interface ClaimStore

Returns:

A read-only Map that maps claim URIs to claim values.

put

public void put(URI claimUri,
                Object value)

Description copied from interface: ClaimStore

Puts the value of a claim in the claim store. If the claim store already contained a value for the specified claim, then the old value will be overwritten.

If the claim is read-only, an IllegalArgumentException is thrown.

If the claim is immutable, and there is not yet a value for the claim in the claim store, the value is stored.

If the claim is immutable, and there is already a value for the claim in the claim store, the value in the claim store is not modified - nothing happens.

Specified by:

put in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

value - The value to put into the claim store.

put

@Deprecated
public void put(URI claimUri,
                             Object value,
                             boolean writeOnce)

Deprecated.

Specified by:

put in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

value - The value to put into the claim store.

writeOnce - true if the claim should be read-only.

put

public void put(URI claimUri,
                Object value,
                ClaimType claimType)

Description copied from interface: ClaimStore

Puts the value of a claim in the claim store. If the claim store already contained a value for the specified claim, then the old value will be overwritten. If the claim is immutable and there is no value for that claim, the value will be set. In case of read-only the value can not be changed.

Specified by:

put in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

value - The value to put into the claim store.

claimType - The type of the claim.

put

public void put(URI claimUri,
                Object value,
                ClaimValueScope claimScope)

Description copied from interface: ClaimStore

Puts the value of a claim in the claim store, under the following conditions.

If the claim is read-only, an IllegalArgumentException is thrown.

If the claim is immutable, the value is only stored if the current value is not set yet. If the claim store already contains a value for this claim, it is not modified.

You can use this method to store claim values for claims which have been defined in the ambient framework configuration or for ad-hoc claims (claims which have not been defined in the configuration). For claims defined in the configuration, the claim scope that is defined in the configuration is used; for ad-hoc claims, the claim scope passed to this method is used.

Specified by:

put in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

value - The value to put into the claim store.

claimScope - The ad-hoc claim scope.

put

public void put(URI claimUri,
                Object value,
                ClaimType claimType,
                ClaimValueScope claimScope)

Description copied from interface: ClaimStore

Puts the value of a claim in the claim store, under the following conditions.

If the claim is read-only, an IllegalArgumentException is thrown.

If the claim is immutable, the value is only stored if the current value is not set yet. If the claim store already contains a value for this claim, it is not modified.

You can use this method to store claim values for claims which have been defined in the ambient framework configuration or for ad-hoc claims (claims which have not been defined in the configuration). For claims defined in the configuration, the claim type and scope that are defined in the configuration are used; for ad-hoc claims, the claim type and scope passed to this method are used.

Specified by:

put in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

value - The value to put into the claim store.

claimType - The type of the claim for ad-hoc claims.

claimScope - The scope of the claim for ad-hoc claims.

getConfiguredClaimScope

public ClaimValueScope getConfiguredClaimScope(URI claimUri)

Description copied from interface: ClaimStore

Returns the configured scope of the claim identified by URI.

Specified by:

getConfiguredClaimScope in interface ClaimStore

Parameters:

claimUri - the claim URI

Returns:

the claim value scope

remove

public void remove(URI claimUri)

Description copied from interface: ClaimStore

Removes the value of a claim from the claim store. If the claim is not in the claim store, nothing happens (no exception is thrown).

Specified by:

remove in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

contains

public boolean contains(URI claimUri)

Description copied from interface: ClaimStore

Returns true if the claim store contains a claim, false otherwise.

Specified by:

contains in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

Returns:

true if the claim store contains a claim, false otherwise.

clearReadOnly

public void clearReadOnly()

Description copied from interface: ClaimStore

Empties the read only set of claims.

Specified by:

clearReadOnly in interface ClaimStore

clearImmutable

public void clearImmutable()

Description copied from interface: ClaimStore

Empties the immutable set of claims.

Specified by:

clearImmutable in interface ClaimStore

isReadOnly

public boolean isReadOnly(URI claimUri)

Description copied from interface: ClaimStore

Returns true if the claim is read-only, false otherwise.

Specified by:

isReadOnly in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

Returns:

true if the claim is read-only, false otherwise.

isImmutable

public boolean isImmutable(URI claimUri)

Description copied from interface: ClaimStore

Returns true if the claim is immutable, false otherwise.

Specified by:

isImmutable in interface ClaimStore

Parameters:

claimUri - The URI of the claim.

Returns:

true if the claim is immutable, false otherwise.

clone

public DefaultClaimStore clone()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. By convention, the object returned by this method should be independent of this object (which is being cloned).

Overrides:

clone in class Object

Returns:

an independent copy of this object.

shrinkStaticClaims

public void shrinkStaticClaims()

Description copied from interface: ClaimStore

Removes all static-scoped claims from claim value map.

Specified by:

shrinkStaticClaims in interface ClaimStore

setReadOnlyClaims

public void setReadOnlyClaims(Collection<URI> readOnlyClaims)

Description copied from interface: ClaimStore

Set a collection of claim as read-only.

Specified by:

setReadOnlyClaims in interface ClaimStore

Parameters:

readOnlyClaims - List of Claims

setImmutableClaims

public void setImmutableClaims(Collection<URI> immutableClaims)

Description copied from interface: ClaimStore

Set a collection of claim as immutable.

Specified by:

setImmutableClaims in interface ClaimStore

Parameters:

immutableClaims - List of Claims

isSessionScopedClaim

public boolean isSessionScopedClaim(ClaimValueScope scope)

Description copied from interface: ClaimStore

Returns true if given scope lives during session.

Specified by:

isSessionScopedClaim in interface ClaimStore

Parameters:

scope - scope of the claim.

Returns:

false if scope is null.

removeRequestScopedClaims

public void removeRequestScopedClaims()

Description copied from interface: ClaimStore

Goes through the claims in the ClaimStore and deletes the ones that don't have a configured scope for SESSION.

Specified by:

removeRequestScopedClaims in interface ClaimStore

getClaimValues

public Map<URI,Object> getClaimValues()

Description copied from interface: ClaimStore

Current values of claims.

Specified by:

getClaimValues in interface ClaimStore

getReadOnly

public Set<URI> getReadOnly()

Description copied from interface: ClaimStore

Claims in this set are read-only.

Specified by:

getReadOnly in interface ClaimStore

getImmutable

public Set<URI> getImmutable()

Specified by:

getImmutable in interface ClaimStore

getAdHocClaimScopes

public Map<URI,ClaimValueScope> getAdHocClaimScopes()

Specified by:

getAdHocClaimScopes in interface ClaimStore