Class SecurityResponse

java.lang.Object

io.helidon.security.SecurityResponse

Direct Known Subclasses:

AuthenticationResponse, AuthorizationResponse, OutboundSecurityResponse

public abstract class SecurityResponse
extends Object

Response from security provider (and security Module).

Nested Class Summary

Nested Classes

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

Method Summary

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

status

public SecurityResponse.SecurityStatus status()

Status of this response.

Returns:

SecurityStatus as the provider responded

statusCode

public OptionalInt statusCode()

Status code (uses HTTP status codes for mapping).

Returns:

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

description

public Optional<String> description()

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

Returns:

Description of current status (optional)

throwable

public Optional<Throwable> throwable()

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

Returns:

Exception causing current failure (optional)

requestHeaders

public Map<String, List<String>> requestHeaders()

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

responseHeaders

public Map<String, List<String>> responseHeaders()

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 String toString()

Overrides:

toString in class Object