Class OutboundSecurityResponse

java.lang.Object

io.helidon.security.SecurityResponse

io.helidon.security.OutboundSecurityResponse

public final class OutboundSecurityResponse
extends SecurityResponse

Response of outbound security provider.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OutboundSecurityResponse.Builder	Builder class to build custom identity propagation 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 OutboundSecurityResponse	abstain()	Abstain from processing this request.
static OutboundSecurityResponse.Builder	builder()	Get an instance of builder to build custom identity propagation response.
static OutboundSecurityResponse	empty()	There is nothing we can add - e.g.
static OutboundSecurityResponse	withHeaders(Map<String, List<String>> headers)	Create a response with these headers.

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

empty

public static OutboundSecurityResponse empty()

There is nothing we can add - e.g. we do not propagate identity.

Returns:

response with no headers

withHeaders

public static OutboundSecurityResponse withHeaders(Map<String, List<String>> headers)

Create a response with these headers. Only needs additional headers (e.g. actual headers sent with request will be existing headers + headers provided here).

Parameters:

headers - Headers to add to request to propagate identity (can also be used to delete headers, if the value list is empty)

Returns:

response correctly initialized

builder

public static OutboundSecurityResponse.Builder builder()

Get an instance of builder to build custom identity propagation response.

Returns:

Builder instance

abstain

public static OutboundSecurityResponse abstain()

Abstain from processing this request.

Returns:

response with abstain status