Package org.pac4j.core.credentials.authenticator

Class LocalCachingAuthenticator

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.credentials.authenticator.LocalCachingAuthenticator

All Implemented Interfaces:

Authenticator

public class LocalCachingAuthenticator
extends InitializableObject
implements Authenticator

An authenticator that caches the result of an authentication based on the credentials. Add the guava dependency to use this class.

Since:

1.8

Author:

Misagh Moayyed

Field Summary

Fields

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

Fields inherited from interface org.pac4j.core.credentials.authenticator.Authenticator

ALWAYS_VALIDATE

Constructor Summary

Constructors

Constructor	Description
LocalCachingAuthenticator()
LocalCachingAuthenticator(Authenticator delegate, int cacheSize, int timeout, TimeUnit timeUnit)
LocalCachingAuthenticator(Authenticator delegate, Store<Credentials,UserProfile> store)

Method Summary

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

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

afterInternalInit, beforeInternalInit, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.slf4j.Logger logger

Constructor Details

LocalCachingAuthenticator

public LocalCachingAuthenticator()

LocalCachingAuthenticator

public LocalCachingAuthenticator(Authenticator delegate,
 Store<Credentials,UserProfile> store)

LocalCachingAuthenticator

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

Method Details

validate

public void validate(Credentials credentials,
 WebContext context,
 SessionStore sessionStore)

Description copied from interface: Authenticator

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

Specified by:

validate in interface Authenticator

Parameters:

credentials - the given credentials

context - the web context

sessionStore - the session store

internalInit

protected void internalInit(boolean forceReinit)

Description copied from class: InitializableObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableObject

removeFromCache

public void removeFromCache(Credentials credentials)

isCached

public boolean isCached(Credentials credentials)

getDelegate

public Authenticator getDelegate()

setDelegate

public void setDelegate(Authenticator 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<Credentials,UserProfile> getStore()

setStore

public void setStore(Store<Credentials,UserProfile> store)

toString

public String toString()

Overrides:

toString in class Object