ClaimStore (Build - API Documentation 11.6.0-1104 API)

All Known Implementing Classes:

DefaultClaimStore, JavaClaimStore
```
public interface ClaimStore
```
The Ambient Claim store used for storing claims during request processing.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearImmutable()` Empties the immutable set of claims.
`void`	`clearReadOnly()` Empties the read only set of claims.
`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. You must use method `put(URI, Object, ClaimType)` in order to add a new claim to the 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. You can supply a `writeOnce` flag to indicate that the value cannot be overwritten.
`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.

- Method Detail
  - get
```
Object get(URI claimUri)
```
    Gets the value of a claim from the claim store. You should prefer to use get(java.net.URI, Class) instead of this method, as it doesn't require you to cast the result.
    
    Parameters:
    
    claimUri - The URI of the claim.
    
    Returns:
    
    The current value of the claim or null if this claim has no current value.
  - get
```
<T> T get(URI claimUri,
          Class<T> cls)
```
    Gets the value of a claim from the claim store.
    
    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.
    
    Throws:
    
    ClassCastException - when the claim value is not of the expected type.
  - getAll
```
Map<URI,Object> getAll()
```
    Gets a map containing all the claim values in the claim store.
    
    Returns:
    
    A read-only Map that maps claim URIs to claim values.
  - getAllReadOnlyClaims
```
Set<URI> getAllReadOnlyClaims()
```
    Gets a set containing all the read only claim in the claim store.
    
    Returns:
    
    A read-only Map that maps claim URIs to claim values.
  - getAllImmutableClaims
```
Set<URI> getAllImmutableClaims()
```
    Gets a set containing all the immutable claim in the claim store.
    
    Returns:
    
    A read-only Map that maps claim URIs to claim values.
  - put
```
void put(URI claimUri,
         Object value)
```
    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.
    
    Parameters:
    
    claimUri - The URI of the claim.
    
    value - The value to put into the claim store.
    
    Throws:
    
    IllegalArgumentException - If the claim is read-only.
  - put
```
@Deprecated
void put(URI claimUri,
                      Object value,
                      boolean writeOnce)
```
    Deprecated. You must use method put(URI, Object, ClaimType) in order to add a new claim to the 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. You can supply a writeOnce flag to indicate that the value cannot be overwritten.
    
    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.
    
    Throws:
    
    IllegalArgumentException - If the claim is read-only.
  - put
```
void put(URI claimUri,
         Object value,
         ClaimType claimType)
```
    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.
    
    Parameters:
    
    claimUri - The URI of the claim.
    
    value - The value to put into the claim store.
    
    claimType - The type of the claim.
    
    Throws:
    
    IllegalArgumentException - If the claim is read-only.
  - put
```
void put(URI claimUri,
         Object value,
         ClaimValueScope claimScope)
```
    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.
    Parameters:
    
    claimUri - The URI of the claim.
    
    value - The value to put into the claim store.
    
    claimScope - The ad-hoc claim scope.
    
    Throws:
    
    IllegalArgumentException - If the claim is read-only.
  - put
```
void put(URI claimUri,
         Object value,
         ClaimType claimType,
         ClaimValueScope claimScope)
```
    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.
    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.
    
    Throws:
    
    IllegalArgumentException - If the claim is read-only.
  - remove
```
void remove(URI claimUri)
```
    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).
    
    Parameters:
    
    claimUri - The URI of the claim.
    
    Throws:
    
    IllegalArgumentException - If the claim is read-only.
  - contains
```
boolean contains(URI claimUri)
```
    Returns true if the claim store contains a claim, false otherwise.
    
    Parameters:
    
    claimUri - The URI of the claim.
    
    Returns:
    
    true if the claim store contains a claim, false otherwise.
  - clearReadOnly
```
void clearReadOnly()
```
    Empties the read only set of claims.
  - clearImmutable
```
void clearImmutable()
```
    Empties the immutable set of claims.
  - isReadOnly
```
boolean isReadOnly(URI claimUri)
```
    Returns true if the claim is read-only, false otherwise.
    
    Parameters:
    
    claimUri - The URI of the claim.
    
    Returns:
    
    true if the claim is read-only, false otherwise.
  - isImmutable
```
boolean isImmutable(URI claimUri)
```
    Returns true if the claim is immutable, false otherwise.
    
    Parameters:
    
    claimUri - The URI of the claim.
    
    Returns:
    
    true if the claim is immutable, false otherwise.
  - setReadOnlyClaims
```
void setReadOnlyClaims(Collection<URI> readOnlyClaims)
```
    Set a collection of claim as read-only.
    
    Parameters:
    
    readOnlyClaims - List of Claims
  - setImmutableClaims
```
void setImmutableClaims(Collection<URI> immutableClaims)
```
    Set a collection of claim as immutable.
    
    Parameters:
    
    immutableClaims - List of Claims
  - removeRequestScopedClaims
```
void removeRequestScopedClaims()
```
    Goes through the claims in the ClaimStore and deletes the ones that don't have a configured scope for SESSION.
  - getClaimValues
```
Map<URI,Object> getClaimValues()
```
    Current values of claims.
  - getReadOnly
```
Set<URI> getReadOnly()
```
    Claims in this set are read-only.
  - getImmutable
```
Set<URI> getImmutable()
```
  - getAdHocClaimScopes
```
Map<URI,ClaimValueScope> getAdHocClaimScopes()
```
  - getConfiguredClaimScope
```
ClaimValueScope getConfiguredClaimScope(URI claimUri)
```
    Returns the configured scope of the claim identified by URI.
    
    Parameters:
    
    claimUri - the claim URI
    
    Returns:
    
    the claim value scope
  - shrinkStaticClaims
```
void shrinkStaticClaims()
```
    Removes all static-scoped claims from claim value map.
  - isSessionScopedClaim
```
boolean isSessionScopedClaim(ClaimValueScope scope)
```
    Returns true if given scope lives during session.
    
    Parameters:
    
    scope - scope of the claim.
    
    Returns:
    
    false if scope is null.

Interface ClaimStore

Method Summary

Method Detail

get

get

getAll

getAllReadOnlyClaims

getAllImmutableClaims

put

put

put

put

put

remove

contains

clearReadOnly

clearImmutable

isReadOnly

isImmutable

setReadOnlyClaims

setImmutableClaims

removeRequestScopedClaims

getClaimValues

getReadOnly

getImmutable

getAdHocClaimScopes

getConfiguredClaimScope

shrinkStaticClaims

isSessionScopedClaim