Package org.pac4j.core.profile.creator

Class LocalCachingProfileCreator

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.profile.creator.LocalCachingProfileCreator

All Implemented Interfaces:

ProfileCreator

public class LocalCachingProfileCreator
extends InitializableObject
implements ProfileCreator

A profile creator that caches the result of a profile creation based on the credentials. Add the guava dependency to use this class.

Since:

5.7.0

Author:

Jerome LELEU

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<UserProfile>	create(Credentials credentials, WebContext context, SessionStore sessionStore)	Create a profile from a credentials.
int	getCacheSize()
ProfileCreator	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(ProfileCreator delegate)
void	setStore(Store<Credentials,UserProfile> store)
void	setTimeout(int timeout)
void	setTimeUnit(TimeUnit timeUnit)
String	toString()

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

LocalCachingProfileCreator

public LocalCachingProfileCreator()

LocalCachingProfileCreator

public LocalCachingProfileCreator(ProfileCreator delegate,
 Store<Credentials,UserProfile> store)

LocalCachingProfileCreator

public LocalCachingProfileCreator(ProfileCreator delegate,
 int cacheSize,
 int timeout,
 TimeUnit timeUnit)

Method Details

create

public Optional<UserProfile> create(Credentials credentials,
 WebContext context,
 SessionStore sessionStore)

Description copied from interface: ProfileCreator

Create a profile from a credentials.

Specified by:

create in interface ProfileCreator

Parameters:

credentials - the given credentials

context - the web context

sessionStore - the session store

Returns:

the created profile (optional)

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 ProfileCreator getDelegate()

setDelegate

public void setDelegate(ProfileCreator 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