Package org.wildfly.security.auth.realm

Class CachingSecurityRealm

java.lang.Object

org.wildfly.security.auth.realm.CachingSecurityRealm

All Implemented Interfaces:

SecurityRealm

Direct Known Subclasses:

CachingModifiableSecurityRealm

public class CachingSecurityRealm
extends Object
implements SecurityRealm

A wrapper class that provides caching capabilities for a SecurityRealm and its identities.

Author:

Pedro Igor

Field Summary

Fields inherited from interface org.wildfly.security.auth.server.SecurityRealm

EMPTY_REALM

Constructor Summary

Constructors

Constructor	Description
CachingSecurityRealm(SecurityRealm realm, RealmIdentityCache cache)	Creates a new instance.
CachingSecurityRealm(SecurityRealm realm, RealmIdentityCache cache, Supplier<Provider[]> providerSupplier)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected SecurityRealm	getCacheableRealm()	Gets wrapped backing realm.
SupportLevel	getCredentialAcquireSupport(Class<? extends Credential> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec)
SupportLevel	getEvidenceVerifySupport(Class<? extends Evidence> evidenceType, String algorithmName)
RealmIdentity	getRealmIdentity(Principal principal)
void	handleRealmEvent(RealmEvent event)
void	removeAllFromCache()	Removes all cached identities from the cache.
void	removeFromCache(Principal principal)	Removes a RealmIdentity referenced by the specified Principal from the cache.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.auth.server.SecurityRealm

getCredentialAcquireSupport, getRealmIdentity, getRealmIdentity

Constructor Detail

CachingSecurityRealm

public CachingSecurityRealm(SecurityRealm realm,
                            RealmIdentityCache cache)

Creates a new instance.

Parameters:

realm - the SecurityRealm whose RealmIdentity should be cached.

cache - the RealmIdentityCache instance

CachingSecurityRealm

public CachingSecurityRealm(SecurityRealm realm,
                            RealmIdentityCache cache,
                            Supplier<Provider[]> providerSupplier)

Creates a new instance.

Parameters:

realm - the SecurityRealm whose RealmIdentity should be cached.

cache - the RealmIdentityCache instance

providerSupplier - the provider supplier to use for verification purposes (must not be null)

Method Detail

getRealmIdentity

public RealmIdentity getRealmIdentity(Principal principal)
                               throws RealmUnavailableException

Specified by:

getRealmIdentity in interface SecurityRealm

Throws:

RealmUnavailableException

getCredentialAcquireSupport

public SupportLevel getCredentialAcquireSupport(Class<? extends Credential> credentialType,
                                                String algorithmName,
                                                AlgorithmParameterSpec parameterSpec)
                                         throws RealmUnavailableException

Specified by:

getCredentialAcquireSupport in interface SecurityRealm

Throws:

RealmUnavailableException

getEvidenceVerifySupport

public SupportLevel getEvidenceVerifySupport(Class<? extends Evidence> evidenceType,
                                             String algorithmName)
                                      throws RealmUnavailableException

Specified by:

getEvidenceVerifySupport in interface SecurityRealm

Throws:

RealmUnavailableException

handleRealmEvent

public void handleRealmEvent(RealmEvent event)

Specified by:

handleRealmEvent in interface SecurityRealm

removeFromCache

public void removeFromCache(Principal principal)

Removes a RealmIdentity referenced by the specified Principal from the cache.

Parameters:

principal - the Principal that references a previously cached realm identity

removeAllFromCache

public void removeAllFromCache()

Removes all cached identities from the cache.

getCacheableRealm

protected SecurityRealm getCacheableRealm()

Gets wrapped backing realm.

Returns:

the wrapped backing realm