Package org.forgerock.openig.tools.userprofile

Class CacheUserProfileService

java.lang.Object

org.forgerock.openig.tools.userprofile.CacheUserProfileService

All Implemented Interfaces:

Closeable, AutoCloseable, UserProfileService

public class CacheUserProfileService
extends Object
implements UserProfileService, Closeable

Create a CacheUserProfileService which is responsible for managing the UserProfile cache. The cache is an AsyncCache, which loads entries asynchronously.

Constructor Summary

Constructors

Constructor	Description
CacheUserProfileService(UserProfileService userProfileService, CaffeineAsyncCache.Builder<String,UserProfile,UserProfileException> cacheBuilder, Duration maximumTimeout)	Creates a new CacheUserProfileService.

Method Summary

Modifier and Type	Method	Description
void	close()
Promise<UserProfile,UserProfileException>	getUserProfile(Context context, String username)	Returns a promise that will be completed with an UserProfile or with an UserProfileException in case of errors.

Methods inherited from class java.lang.Object

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

Constructor Details

CacheUserProfileService

public CacheUserProfileService(UserProfileService userProfileService,
 CaffeineAsyncCache.Builder<String,UserProfile,UserProfileException> cacheBuilder,
 Duration maximumTimeout)

Creates a new CacheUserProfileService.

Parameters:

userProfileService - The UserProfileService to execute when a UserProfile is not found in the cache

cacheBuilder - The cache builder to use. Cannot be null.

maximumTimeout - The maximum time to cache a user profile. Cannot be null.

Method Details

getUserProfile

public Promise<UserProfile,UserProfileException> getUserProfile(Context context,
 String username)

Description copied from interface: UserProfileService

Returns a promise that will be completed with an UserProfile or with an UserProfileException in case of errors.

Specified by:

getUserProfile in interface UserProfileService

Parameters:

context - The request context.

username - The username that identifies the user to retrieve the profile attributes for.

Returns:

a promise that will be completed with UserProfile or with an ResourceException in case of errors.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable