org.pac4j.core.credentials.authenticator

Class LocalCachingAuthenticator<T extends Credentials>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.credentials.authenticator.LocalCachingAuthenticator<T>

All Implemented Interfaces:

Authenticator<T>

public class LocalCachingAuthenticator<T extends Credentials>
extends InitializableWebObject
implements Authenticator<T>

An authenticator that caches the result of an authentication event locally. The authentication is delegated to a pluggable component. Add the guava dependency to use this class.

Since:

1.8

Author:

Misagh Moayyed

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
LocalCachingAuthenticator()
LocalCachingAuthenticator(Authenticator<T> delegate, int cacheSize, int timeout, TimeUnit timeUnit)
LocalCachingAuthenticator(Authenticator<T> delegate, Store<T,CommonProfile> store)

Method Summary

Modifier and Type	Method and Description
int	getCacheSize()
Authenticator<T>	getDelegate()
Store<T,CommonProfile>	getStore()
int	getTimeout()
TimeUnit	getTimeUnit()
protected void	internalInit(WebContext context) Internal initialization of the object.
boolean	isCached(T credentials)
void	removeFromCache(T credentials)
void	setCacheSize(int cacheSize)
void	setDelegate(Authenticator<T> delegate)
void	setStore(Store<T,CommonProfile> store)
void	setTimeout(int timeout)
void	setTimeUnit(TimeUnit timeUnit)
String	toString()
void	validate(T credentials, WebContext context) Validate the credentials.

Methods inherited from class org.pac4j.core.util.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

LocalCachingAuthenticator

public LocalCachingAuthenticator()

LocalCachingAuthenticator

public LocalCachingAuthenticator(Authenticator<T> delegate,
                                 Store<T,CommonProfile> store)

LocalCachingAuthenticator

public LocalCachingAuthenticator(Authenticator<T> delegate,
                                 int cacheSize,
                                 int timeout,
                                 TimeUnit timeUnit)

Method Detail

validate

public void validate(T credentials,
                     WebContext context)
              throws HttpAction,
                     CredentialsException

Description copied from interface: Authenticator

Validate the credentials. It should throw a CredentialsException in case of failure.

Specified by:

validate in interface Authenticator<T extends Credentials>

Parameters:

credentials - the given credentials

context - the web context

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableWebObject

Parameters:

context - the web context

removeFromCache

public void removeFromCache(T credentials)

isCached

public boolean isCached(T credentials)

getDelegate

public Authenticator<T> getDelegate()

setDelegate

public void setDelegate(Authenticator<T> delegate)

getCacheSize

public int getCacheSize()

setCacheSize

public void setCacheSize(int cacheSize)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

getTimeUnit

public TimeUnit getTimeUnit()

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

getStore

public Store<T,CommonProfile> getStore()

setStore

public void setStore(Store<T,CommonProfile> store)

toString

public String toString()

Overrides:

toString in class Object