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

Class RestAuthenticator

java.lang.Object

org.apache.juneau.rest.server.auth.RestAuthenticator

Direct Known Subclasses:

RestAuthenticator.Null

public abstract class RestAuthenticator
extends Object

Resource-level authentication SPI for @Rest resources.

Resolves a request's Principal and roles, reusing the same Authenticator implementations (SAML/OAuth/JWT/API-key) used by the servlet-filter layer. Same three-state contract as Authenticator:

• Optional.empty() — does not apply (anonymous passthrough).
• Optional.of(AuthResult) — authentication succeeded.
• throw AuthenticationException — credentials present but invalid.

See Also:

• Authenticator
• AuthResult
• REST Authenticator — Resource-Level Authentication

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RestAuthenticator.Null	Sentinel "unset" type for @Rest(authenticator=...); never authenticates.

Constructor Summary

Constructors

Constructor	Description
RestAuthenticator()

Method Summary

Modifier and Type	Method	Description
abstract Optional<AuthResult>	authenticate(RestRequest req)	Resolves identity + roles for the request.
static RestAuthenticator	of(Authenticator a)	Adapts any Authenticator (e.g. an AuthFilter or AuthFilterChain bean) into a RestAuthenticator.

Methods inherited from class java.lang.Object

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

Constructor Details

RestAuthenticator

public RestAuthenticator()

Method Details

authenticate

public abstract Optional<AuthResult> authenticate(RestRequest req)
                                           throws AuthenticationException

Resolves identity + roles for the request.

Parameters:

req - The REST request. Never null.

Returns:

The auth result, or Optional.empty() if this authenticator does not apply.

Throws:

AuthenticationException - If credentials are present but invalid.

of

public static RestAuthenticator of(Authenticator a)

Adapts any Authenticator (e.g. an AuthFilter or AuthFilterChain bean) into a RestAuthenticator.

Parameters:

a - The authenticator to adapt. Must not be null.

Returns:

A new RestAuthenticator.