Class AuthorizationResponse

java.lang.Object

io.helidon.security.SecurityResponse

io.helidon.security.AuthorizationResponse

public final class AuthorizationResponse
extends SecurityResponse

Response from an authorization decision.

Responses that can be returned based on SecurityResponse.SecurityStatus:

• Success - request is authorized an may proceed - see permit()
• Failure - request is denied and must not proceed - see deny()
• Abstain - the provider could not decide about this request - see abstain()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthorizationResponse.Builder	Builder for custom Authorization responses.

Nested classes/interfaces inherited from class SecurityResponse

SecurityResponse.SecurityStatus

Modifier and Type	Class	Description
static enum	SecurityResponse.SecurityStatus	Status of a security operation.

Method Summary

Modifier and Type	Method	Description
static AuthorizationResponse	abstain()	This provider is not capable of making a decision about the resource (e.g.
static AuthorizationResponse.Builder	builder()	Builder for fully customized authorization response.
static AuthorizationResponse	deny()	Deny the request.
boolean	isPermitted()	Returns true if access to resource was permitted.
static AuthorizationResponse	permit()	Permit the request.

Methods inherited from class SecurityResponse

description, requestHeaders, responseHeaders, status, statusCode, throwable, toString

Modifier and Type	Method	Description
Optional<String>	description()	Description of current security status.
Map<String, List<String>>	requestHeaders()	Get new request headers to be used.
Map<String, List<String>>	responseHeaders()	Get new response headers to be used.
SecurityResponse.SecurityStatus	status()	Status of this response.
OptionalInt	statusCode()	Status code (uses HTTP status codes for mapping).
Optional<Throwable>	throwable()	Get underlying throwable causing a failure state (if such happened).
String	toString()

Methods inherited from class Object

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

Method Details

permit

public static AuthorizationResponse permit()

Permit the request.

Returns:

correctly initialized response

deny

public static AuthorizationResponse deny()

Deny the request.

Returns:

correctly initialized response

abstain

public static AuthorizationResponse abstain()

This provider is not capable of making a decision about the resource (e.g. does not know the resource).

Returns:

correctly initialized response

builder

public static AuthorizationResponse.Builder builder()

Builder for fully customized authorization response.

Returns:

Builder instance ready for configuration

isPermitted

public boolean isPermitted()

Returns true if access to resource was permitted.

Returns:

true if permitted, false if denied or abstained.