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

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

OAuth 2.0 / OIDC integration for the Juneau REST server.

Layered on the AuthFilter framework and the TokenValidator SPI. Wraps Nimbus's oauth2-oidc-sdk (Apache 2.0) for the introspection, flow, and discovery wire shapes.

The Nimbus dependency is declared provided-scope in juneau-rest-server-auth-oauth's POM, so it never bleeds into the dependency tree of an upstream module. Consumers who want OAuth functionality declare com.nimbusds:oauth2-oidc-sdk themselves at runtime.

Key types

• OAuthIntrospectionValidator — opaque-token validator wrapping Nimbus's RFC 7662 introspection client.
• OAuthFilter — servlet filter that recognizes Authorization: Bearer ... OAuth tokens.
• TokenCache — cache SPI used by the validator (and the caching flow decorator); default impl BoundedLruTokenCache.
• CachingClientCredentialsFlow — server-side caching decorator layering a TokenCache over the role-neutral OAuthClientCredentialsFlow.

See Also:

• RFC 6749 — OAuth 2.0
• RFC 7662 — Token Introspection
• OAuth 2.0 / OIDC AuthN Support (juneau-rest-server-auth-oauth)

Since:

10.0.0

Related Packages

Package	Description
org.apache.juneau.rest.server.auth	Authentication (AuthN) guards, servlet-layer filters, SPIs, and request-time helpers for juneau-rest-server.
org.apache.juneau.rest.server.auth.jwt	JWT bearer-token validation backed by com.nimbusds:nimbus-jose-jwt.
org.apache.juneau.rest.server.auth.saml	SAML 2.0 assertion validation for the Juneau REST server, layered on the AuthFilter framework.

Class	Description
BoundedLruTokenCache	Thread-safe bounded LRU implementation of TokenCache.
CachingClientCredentialsFlow	Server-side caching decorator layering an optional TokenCache over the role-neutral OAuthClientCredentialsFlow.
CachingClientCredentialsFlow.Builder	Builder.
OAuthFilter	AuthFilter that authenticates requests carrying an OAuth 2.0 / OIDC access token via the standard RFC 6750 Bearer Token scheme.
OAuthFilter.Builder	Builder.
OAuthIntrospectionValidator	TokenValidator that validates opaque OAuth 2.0 access tokens via the RFC 7662 Token Introspection endpoint.
OAuthIntrospectionValidator.Builder	Builder for OAuthIntrospectionValidator.
TokenCache	SPI for caching the result of an OAuth introspection or token-acquisition call.