Package io.helidon.security

Class OutboundSecurityResponse.Builder

java.lang.Object

io.helidon.security.OutboundSecurityResponse.Builder

All Implemented Interfaces:

Builder<OutboundSecurityResponse>, java.util.function.Supplier<OutboundSecurityResponse>

Enclosing class:

OutboundSecurityResponse

public static class OutboundSecurityResponse.Builder
extends java.lang.Object

Builder class to build custom identity propagation responses.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OutboundSecurityResponse	build() Build identity propagation response based on this builder.
T	description(java.lang.String description) Set description of this security response failure.
T	requestHeader(java.lang.String header, java.util.List<java.lang.String> values) Add a multi-value header.
T	requestHeader(java.lang.String header, java.lang.String value) Add a single-value header.
T	requestHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers) Set additional/replacement headers for request.
T	responseHeader(java.lang.String header, java.util.List<java.lang.String> values) Add a multi-value header.
T	responseHeader(java.lang.String header, java.lang.String value) Add a single-value header.
T	responseHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers) Set additional/replacement headers for request.
T	status(SecurityResponse.SecurityStatus status) Set security status of this security response.
T	statusCode(int statusCode) Set a status code for failed statuses.
T	throwable(java.lang.Throwable exception) Set throwable causing failure of the security request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Constructor Detail

Builder

public Builder()

Method Detail

build

public OutboundSecurityResponse build()

Build identity propagation response based on this builder.

Returns:

identity propagation response

statusCode

public T statusCode(int statusCode)

Set a status code for failed statuses. This is expected to use HTTP status codes. If an integration is done with a non-http protocol, you must map these status codes appropriately.

Parameters:

statusCode - HTTP status code

Returns:

updated builder instance

status

public T status(SecurityResponse.SecurityStatus status)

Set security status of this security response.

Parameters:

status - Status to set

Returns:

updated builder instance

description

public T description(java.lang.String description)

Set description of this security response failure.

Parameters:

description - Description to provide to called in case of failed security, or null if no information can be provided

Returns:

updated builder instance

throwable

public T throwable(java.lang.Throwable exception)

Set throwable causing failure of the security request.

Parameters:

exception - Exception that caused failure

Returns:

updated builder instance

requestHeaders

public T requestHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Set additional/replacement headers for request.

Parameters:

headers - map with headers

Returns:

updated builder instance

requestHeader

public T requestHeader(java.lang.String header,
                       java.lang.String value)

Add a single-value header. Note that if method requestHeaders(Map) is called after this method, it will remove changes by this method.

Parameters:

header - header name

value - header value

Returns:

this instance

requestHeader

public T requestHeader(java.lang.String header,
                       java.util.List<java.lang.String> values)

Add a multi-value header. Note that if method requestHeaders(Map) is called after this method, it may remove changes by this method.

Parameters:

header - header name

values - header values

Returns:

this instance

responseHeaders

public T responseHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Set additional/replacement headers for request.

Parameters:

headers - map with headers

Returns:

updated builder instance

responseHeader

public T responseHeader(java.lang.String header,
                        java.lang.String value)

Add a single-value header. Note that if method responseHeaders(Map) is called after this method, it will remove changes by this method.

Parameters:

header - header name

value - header value

Returns:

this instance

responseHeader

public T responseHeader(java.lang.String header,
                        java.util.List<java.lang.String> values)

Add a multi-value header. Note that if method responseHeaders(Map) is called after this method, it may remove changes by this method.

Parameters:

header - header name

values - header values

Returns:

this instance