Package org.apache.juneau.rest.server.auth.oauth

Class CachingClientCredentialsFlow

java.lang.Object

org.apache.juneau.rest.server.auth.oauth.CachingClientCredentialsFlow

public class CachingClientCredentialsFlow
extends Object

Server-side caching decorator layering an optional TokenCache over the role-neutral OAuthClientCredentialsFlow.

The neutral flow performs the RFC 6749 §4.4 client-credentials token acquisition; this decorator adds the server-side (clientId, scope)-keyed cache so repeat callers within the cache window reuse the token rather than hitting the IdP on each call. When no cache is configured the decorator simply delegates to the neutral flow.

Usage

var token = CachingClientCredentialsFlow.create() .tokenEndpoint(URI.create("https://idp.example.com/oauth2/token")) .clientId("worker-service") .clientSecret("...") .scope("read:orders") .tokenCache(BoundedLruTokenCache.create()) .build() .acquire();

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CachingClientCredentialsFlow.Builder	Builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CachingClientCredentialsFlow(CachingClientCredentialsFlow.Builder b)	Constructor.

Method Summary

Modifier and Type	Method	Description
OAuthToken	acquire()	Acquires a token, returning the cached token when a fresh one is present.
static CachingClientCredentialsFlow.Builder	create()	Static creator.

Methods inherited from class java.lang.Object

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

Constructor Details

CachingClientCredentialsFlow

protected CachingClientCredentialsFlow(CachingClientCredentialsFlow.Builder b)

Constructor.

Parameters:

b - The builder.

Method Details

create

public static CachingClientCredentialsFlow.Builder create()

Static creator.

Returns:

A new builder.

acquire

public OAuthToken acquire()

Acquires a token, returning the cached token when a fresh one is present.

Returns:

The acquired token.