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

Class AuthResult

java.lang.Object

org.apache.juneau.rest.server.auth.AuthResult

public final class AuthResult
extends Object

Immutable value type returned by Authenticator.authenticate(jakarta.servlet.http.HttpServletRequest) on success.

Carries the resolved Principal and the set of roles associated with the authenticated subject. The role set may be empty when no role claims are available (the principal is still valid).

See Also:

• AuthFilter
• AuthFilterChain
• AuthN Filter Framework — Servlet-Layer Authentication

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AuthResult.MergeMode	Controls how an AuthResult merges with results accumulated earlier in an authenticator chain.

Method Summary

Modifier and Type	Method	Description
AuthResult.MergeMode	getMode()	Returns the merge mode for this result.
Principal	getPrincipal()	Returns the authenticated principal.
Set<String>	getRoles()	Returns the unmodifiable set of roles granted to this principal.
static AuthResult	of(Principal principal, String... roles)	Creates an AuthResult with the specified principal and roles using AuthResult.MergeMode.ADD mode.
static AuthResult	of(Principal principal, Set<String> roles)	Creates an AuthResult with the specified principal and role set using AuthResult.MergeMode.ADD mode.
static AuthResult	ofRoles(String... roles)	Creates a roles-only AuthResult (AuthResult.MergeMode.ADD mode, null principal).
static AuthResult	ofRoles(Collection<String> roles)	Creates a roles-only AuthResult (AuthResult.MergeMode.ADD mode, null principal).
static AuthResult	replacing(Principal principal, String... roles)	Creates an AuthResult that replaces any accumulated identity and roles.
static AuthResult	replacing(Principal principal, Set<String> roles)	Creates an AuthResult that replaces any accumulated identity and roles.

Methods inherited from class java.lang.Object

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

Method Details

of

public static AuthResult of(Principal principal,
 String... roles)

Creates an AuthResult with the specified principal and roles using AuthResult.MergeMode.ADD mode.

Parameters:

principal - The authenticated principal. Must not be null.

roles - The roles granted to this principal. May be empty.

Returns:

A new AuthResult.

of

public static AuthResult of(Principal principal,
 Set<String> roles)

Creates an AuthResult with the specified principal and role set using AuthResult.MergeMode.ADD mode.

Parameters:

principal - The authenticated principal. Must not be null.

roles - The roles granted to this principal. May be null or empty.

Returns:

A new AuthResult.

ofRoles

public static AuthResult ofRoles(String... roles)

Creates a roles-only AuthResult (AuthResult.MergeMode.ADD mode, null principal).

Use this to contribute additional roles without supplying a principal — the accumulated/inherited principal is kept. This replaces the need for a separate roles-only authenticator type.

Parameters:

roles - The roles to contribute. May be empty.

Returns:

A new AuthResult.

ofRoles

public static AuthResult ofRoles(Collection<String> roles)

Creates a roles-only AuthResult (AuthResult.MergeMode.ADD mode, null principal).

Parameters:

roles - The roles to contribute. May be null or empty.

Returns:

A new AuthResult.

replacing

public static AuthResult replacing(Principal principal,
 String... roles)

Creates an AuthResult that replaces any accumulated identity and roles.

Parameters:

principal - The authenticated principal. Must not be null.

roles - The roles granted to this principal. May be empty.

Returns:

A new AuthResult.

replacing

public static AuthResult replacing(Principal principal,
 Set<String> roles)

Creates an AuthResult that replaces any accumulated identity and roles.

Parameters:

principal - The authenticated principal. Must not be null.

roles - The roles granted to this principal. May be null or empty.

Returns:

A new AuthResult.

getPrincipal

public Principal getPrincipal()

Returns the authenticated principal.

Returns:

The authenticated principal. May be null for a roles-only (AuthResult.MergeMode.ADD) result.

getMode

public AuthResult.MergeMode getMode()

Returns the merge mode for this result.

Returns:

The merge mode. Never null.

Since:

10.0.0

getRoles

public Set<String> getRoles()

Returns the unmodifiable set of roles granted to this principal.

Returns:

The role set. Never null; may be empty.