IdentityCache (WildFly Elytron Parent 2.1.0.Final API)

All Known Subinterfaces:

SingleSignOnSession

All Known Implementing Classes:

DefaultSingleSignOnSession, ProgrammaticSingleSignOnCache
```
public interface IdentityCache
```
An identity cache is responsible to provide a specific caching strategy for identities. It should be used in conjunction with CachedIdentityAuthorizeCallback when performing authorization within a authentication mechanism.
Implementations of this interface are specific for each authentication mechanism.

Author:

Pedro Igor

See Also:

CachedIdentityAuthorizeCallback

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CachedIdentity`	`get()`	Returns an identity previously cached.
`void`	`put(SecurityIdentity identity)`	Puts a `SecurityIdentity` into the cache.
`CachedIdentity`	`remove()`	Removes an identity from the cache.

- Method Detail
  - put
```
void put(SecurityIdentity identity)
```
    Puts a SecurityIdentity into the cache.
    
    Parameters:
    
    identity - the identity to cache (not null)
  - get
```
CachedIdentity get()
```
    Returns an identity previously cached.
    
    Returns:
    
    the cached identity or null if there is no identity in the cache
  - remove
```
CachedIdentity remove()
```
    Removes an identity from the cache.
    
    Returns:
    
    the cached identity or null if there is no identity in the cache