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

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.http.response.BasicHttpException

org.apache.juneau.http.response.Unauthorized

org.apache.juneau.rest.server.auth.AuthenticationException

All Implemented Interfaces:

Serializable, HttpResponseMessage

public class AuthenticationException
extends Unauthorized

Specialization of Unauthorized thrown by BearerTokenGuard, ApiKeyGuard, and user-supplied TokenValidator / ApiKeyStore implementations to signal AuthN failure.

Behaves like a plain 401 Unauthorized from the wire's perspective — same status code, same reason phrase, same JSON / problem-details body shape — but adds a typed wwwAuthenticate(String) fluent setter that returns AuthenticationException (instead of the generic BasicHttpException returned by the inherited setHeader(...) chain) so authoring AuthN guards stays terse:

throw new AuthenticationException("Bearer token missing") .wwwAuthenticate("Bearer realm=\"api\"");

The WWW-Authenticate response header is mandated by RFC 7235 §4.1 for every 401 response — clients use the challenge string to discover which authentication schemes the server supports and to format their next request. AuthN guards in this package set it on every rejection.

See Also:

• Unauthorized
• BearerTokenGuard
• ApiKeyGuard
• RFC 7235 §4.1 — WWW-Authenticate
• AuthN Guards — Bearer / API-Key / JWT

Since:

10.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.http.response.Unauthorized

Unauthorized.Unmodifiable

Field Summary

Fields inherited from class org.apache.juneau.http.response.Unauthorized

REASON_PHRASE, STATUS_CODE

Constructor Summary

Constructors

Constructor	Description
AuthenticationException()	Constructor with no message.
AuthenticationException(String msg, Object... args)	Constructor with a String.format-style message.
AuthenticationException(Throwable cause)	Constructor with a cause.
AuthenticationException(Throwable cause, String msg, Object... args)	Constructor with a cause and a String.format-style message.

Method Summary

Modifier and Type	Method	Description
AuthenticationException	wwwAuthenticate(String value)	Sets the WWW-Authenticate response header to the supplied challenge string.

Methods inherited from class org.apache.juneau.http.response.Unauthorized

unmodifiable

Methods inherited from class org.apache.juneau.http.response.BasicHttpException

addHeader, addHeader, equals, freeze, getBody, getFullStackMessage, getHeaders, getLocale, getMessage, getRootCause, getStatusCode, getStatusLine, hashCode, isUnmodifiable, modify, setBody, setContent, setContent, setHeader, setHeader, setHeaders, setHeaders, setLocale, setProtocolVersion, setReasonPhrase, setStatusCode, setStatusLine, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.juneau.http.response.HttpResponseMessage

getFirstHeader, getHeaders

Constructor Details

AuthenticationException

public AuthenticationException()

Constructor with no message.

AuthenticationException

public AuthenticationException(String msg,
 Object... args)

Constructor with a String.format-style message.

Parameters:

msg - The detail message. May be null. Treated as a format pattern when args is non-empty.

args - Optional message arguments.

AuthenticationException

public AuthenticationException(Throwable cause)

Constructor with a cause.

Parameters:

cause - The cause. May be null.

AuthenticationException

public AuthenticationException(Throwable cause,
 String msg,
 Object... args)

Constructor with a cause and a String.format-style message.

Parameters:

cause - The cause. May be null.

msg - The detail message. May be null. Treated as a format pattern when args is non-empty.

args - Optional message arguments.

Method Details

wwwAuthenticate

public AuthenticationException wwwAuthenticate(String value)

Sets the WWW-Authenticate response header to the supplied challenge string.

Per RFC 7235 §4.1, the challenge identifies the authentication scheme(s) the server accepts and any scheme-specific parameters (e.g. realm). Examples:

• Bearer realm="api"
• Bearer realm="api", error="invalid_token", error_description="The access token expired"
• ApiKey realm="api"

Parameters:

value - The WWW-Authenticate challenge value. Must not be null.

Returns:

This object.