Package io.helidon.security

Class SecurityResponse

java.lang.Object

io.helidon.security.SecurityResponse

Direct Known Subclasses:

AuthenticationResponse, AuthorizationResponse, OutboundSecurityResponse

public abstract class SecurityResponse
extends java.lang.Object

Response from security provider (and security Module).

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getDescription() Description of current security status.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestHeaders() Get new request headers to be used.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResponseHeaders() Get new response headers to be used.
SecurityResponse.SecurityStatus	getStatus() Status of this response.
java.util.OptionalInt	getStatusCode() Status code (uses HTTP status codes for mapping).
java.util.Optional<java.lang.Throwable>	getThrowable() Get underlying throwable causing a failure state (if such happened).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getStatus

public SecurityResponse.SecurityStatus getStatus()

Status of this response.

Returns:

SecurityStatus as the provider responded

getStatusCode

public java.util.OptionalInt getStatusCode()

Status code (uses HTTP status codes for mapping).

Returns:

HTTP status code the provider wants to use, or empty if not set

getDescription

public java.util.Optional<java.lang.String> getDescription()

Description of current security status. Should be provided by security providers mostly for failure cases.

Returns:

Description of current status (optional)

getThrowable

public java.util.Optional<java.lang.Throwable> getThrowable()

Get underlying throwable causing a failure state (if such happened).

Returns:

Exception causing current failure (optional)

getRequestHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestHeaders()

Get new request headers to be used. These may be additional header, replacement headers or "clearing" headers (in case the value is empty list).

Returns:

Map of headers to merge with existing headers

getResponseHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResponseHeaders()

Get new response headers to be used. These may be additional header, replacement headers or "clearing" headers (in case the value is empty list).

Returns:

Map of headers to merge with existing headers

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object