Class BearerAuthenticationChallenge

java.lang.Object

com.soklet.BearerAuthenticationChallenge

@ThreadSafe
public final class BearerAuthenticationChallenge
extends Object

An immutable RFC 6750 Bearer challenge with an RFC 9728 protected-resource metadata URL. getHeaderValue() renders one WWW-Authenticate field value, without the field name. Constructing a challenge validates its syntax; the application remains responsible for publishing the metadata and choosing scopes its authorization server can grant.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BearerAuthenticationChallenge.Builder	Mutable builder for one immutable Bearer challenge.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)	Compares the validated challenge fields.
@NonNull Optional<@NonNull BearerAuthenticationError>	getError()
@NonNull Optional<@NonNull String>	getErrorDescription()
@NonNull Optional<@NonNull URI>	getErrorUri()
@NonNull String	getHeaderValue()
@NonNull Optional<@NonNull String>	getRealm()
@NonNull Integer	getRecommendedStatusCode()	Returns the RFC-recommended HTTP status for this challenge: 400 for an invalid request, 403 for insufficient scope, and 401 otherwise.
@NonNull List<@NonNull String>	getRequiredScopes()
@NonNull URI	getResourceMetadataUri()
int	hashCode()
@NonNull String	toString()
static @NonNull BearerAuthenticationChallenge.Builder	withResourceMetadataUri(@NonNull URI resourceMetadataUri)

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withResourceMetadataUri

public static @NonNull BearerAuthenticationChallenge.Builder withResourceMetadataUri(@NonNull URI resourceMetadataUri)

Returns:

a builder with the configured protected-resource metadata URL

getResourceMetadataUri

public @NonNull URI getResourceMetadataUri()

Returns:

the configured absolute protected-resource metadata URI

getError

public @NonNull Optional<@NonNull BearerAuthenticationError> getError()

Returns:

the RFC 6750 Bearer error, when supplied

getRequiredScopes

public @NonNull List<@NonNull String> getRequiredScopes()

Returns:

immutable scope tokens in first-encounter order

getRealm

public @NonNull Optional<@NonNull String> getRealm()

Returns:

the protection realm, when supplied

getErrorDescription

public @NonNull Optional<@NonNull String> getErrorDescription()

Returns:

the developer-facing error description, when supplied

getErrorUri

public @NonNull Optional<@NonNull URI> getErrorUri()

Returns:

the error explanation URI, when supplied

getRecommendedStatusCode

public @NonNull Integer getRecommendedStatusCode()

Returns the RFC-recommended HTTP status for this challenge: 400 for an invalid request, 403 for insufficient scope, and 401 otherwise.

Returns:

recommended HTTP status

getHeaderValue

public @NonNull String getHeaderValue()

Returns:

the complete WWW-Authenticate field value

equals

public boolean equals(@Nullable Object other)

Compares the validated challenge fields.

Overrides:

equals in class Object

Returns:

whether both challenges contain the same fields

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

a hash code for the validated challenge fields

toString

public @NonNull String toString()

Overrides:

toString in class Object

Returns:

a concise description that omits scope and URI details