Package io.quarkus.oidc.runtime

Class DefaultTokenIntrospectionUserInfoCache

java.lang.Object

io.quarkus.oidc.runtime.DefaultTokenIntrospectionUserInfoCache

All Implemented Interfaces:

TokenIntrospectionCache, UserInfoCache

public class DefaultTokenIntrospectionUserInfoCache
extends Object
implements TokenIntrospectionCache, UserInfoCache

Default TokenIntrospection and UserInfo Cache implementation. A single cache entry can keep TokenIntrospection and/or UserInfo.

In most cases it is the opaque bearer access tokens which are introspected but the code flow access tokens can also be introspected if they have the roles claims.

In either case, if a remote request to fetch UserInfo is required then it will be the same access token which has been introspected which will be used to request UserInfo.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final MemoryCache<io.quarkus.oidc.runtime.DefaultTokenIntrospectionUserInfoCache.CacheEntry>	cache

Constructor Summary

Constructors

Constructor	Description
DefaultTokenIntrospectionUserInfoCache(OidcConfig oidcConfig, io.vertx.core.Vertx vertx)

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<Void>	addIntrospection(String token, TokenIntrospection introspection, OidcTenantConfig oidcTenantConfig, OidcRequestContext<Void> requestContext)	Add a new TokenIntrospection result to the cache.
io.smallrye.mutiny.Uni<Void>	addUserInfo(String token, UserInfo userInfo, OidcTenantConfig oidcTenantConfig, OidcRequestContext<Void> requestContext)	Add a new UserInfo to the cache.
void	clearCache()
int	getCacheSize()
io.smallrye.mutiny.Uni<TokenIntrospection>	getIntrospection(String token, OidcTenantConfig oidcConfig, OidcRequestContext<TokenIntrospection> requestContext)	Get the cached TokenIntrospection result.
io.smallrye.mutiny.Uni<UserInfo>	getUserInfo(String token, OidcTenantConfig oidcConfig, OidcRequestContext<UserInfo> requestContext)	Get the cached UserInfo.
(package private) void	shutdown(ShutdownEvent event, io.vertx.core.Vertx vertx)

Methods inherited from class java.lang.Object

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

Field Details

cache

final MemoryCache<io.quarkus.oidc.runtime.DefaultTokenIntrospectionUserInfoCache.CacheEntry> cache

Constructor Details

DefaultTokenIntrospectionUserInfoCache

public DefaultTokenIntrospectionUserInfoCache(OidcConfig oidcConfig,
 io.vertx.core.Vertx vertx)

Method Details

addIntrospection

public io.smallrye.mutiny.Uni<Void> addIntrospection(String token,
 TokenIntrospection introspection,
 OidcTenantConfig oidcTenantConfig,
 OidcRequestContext<Void> requestContext)

Description copied from interface: TokenIntrospectionCache

Add a new TokenIntrospection result to the cache.

Specified by:

addIntrospection in interface TokenIntrospectionCache

Parameters:

token - the token which has been introspected

introspection - the token introspection result

oidcTenantConfig - the tenant configuration

requestContext - the request context which can be used to run the blocking tasks

getIntrospection

public io.smallrye.mutiny.Uni<TokenIntrospection> getIntrospection(String token,
 OidcTenantConfig oidcConfig,
 OidcRequestContext<TokenIntrospection> requestContext)

Description copied from interface: TokenIntrospectionCache

Get the cached TokenIntrospection result.

Specified by:

getIntrospection in interface TokenIntrospectionCache

Parameters:

token - the token which has to be introspected

oidcConfig - the tenant configuration

requestContext - the request context which can be used to run the blocking tasks

addUserInfo

public io.smallrye.mutiny.Uni<Void> addUserInfo(String token,
 UserInfo userInfo,
 OidcTenantConfig oidcTenantConfig,
 OidcRequestContext<Void> requestContext)

Description copied from interface: UserInfoCache

Add a new UserInfo to the cache.

Specified by:

addUserInfo in interface UserInfoCache

Parameters:

token - the token which was used to get UserInfo

userInfo - UserInfo

oidcTenantConfig - the tenant configuration

requestContext - the request context which can be used to run the blocking tasks

getUserInfo

public io.smallrye.mutiny.Uni<UserInfo> getUserInfo(String token,
 OidcTenantConfig oidcConfig,
 OidcRequestContext<UserInfo> requestContext)

Description copied from interface: UserInfoCache

Get the cached UserInfo.

Specified by:

getUserInfo in interface UserInfoCache

Parameters:

token - the token which will be used to get new UserInfo if no UserInfo is cached. Effectively this token is a cache key which has to be stored when UserInfoCache.addUserInfo(String, UserInfo, OidcTenantConfig, AddUserInfoRequestContext) is called.

oidcConfig - the tenant configuration

requestContext - the request context which can be used to run the blocking tasks

clearCache

public void clearCache()

getCacheSize

public int getCacheSize()

shutdown

void shutdown(@Observes
 ShutdownEvent event,
 io.vertx.core.Vertx vertx)