Package io.helidon.security

Class AuthenticationResponse.Builder

java.lang.Object

io.helidon.security.AuthenticationResponse.Builder

All Implemented Interfaces:

Builder<AuthenticationResponse>, Supplier<AuthenticationResponse>

Enclosing class:

AuthenticationResponse

public static final class AuthenticationResponse.Builder
extends Object

Authentication response builder. Allows fully customized response, if one of the static methods is not sufficient (e.g. when returning a specialized SecurityStatus.

Method Summary

Modifier and Type	Method and Description
AuthenticationResponse	build() Build authentication response.
T	description(String description) Set description of this security response failure.
T	requestHeader(String header, List<String> values) Add a multi-value header.
T	requestHeader(String header, String value) Add a single-value header.
T	requestHeaders(Map<String,List<String>> headers) Set additional/replacement headers for request.
T	responseHeader(String header, List<String> values) Add a multi-value header.
T	responseHeader(String header, String value) Add a single-value header.
T	responseHeaders(Map<String,List<String>> headers) Set additional/replacement headers for request.
AuthenticationResponse.Builder	service(Subject subject) Set the service subject as created by this provider.
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(Throwable exception) Set throwable causing failure of the security request.
AuthenticationResponse.Builder	user(Subject subject) Set the user subject as created by this provider.

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

Method Detail

user

public AuthenticationResponse.Builder user(Subject subject)

Set the user subject as created by this provider.

Parameters:

subject - Subject to set for current request

Returns:

updated builder instance

service

public AuthenticationResponse.Builder service(Subject subject)

Set the service subject as created by this provider.

Parameters:

subject - Subject to set for current request

Returns:

updated builder instance

build

public AuthenticationResponse build()

Build authentication response.

Returns:

Response based on this builder

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(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(Throwable exception)

Set throwable causing failure of the security request.

Parameters:

exception - Exception that caused failure

Returns:

updated builder instance

requestHeaders

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

Set additional/replacement headers for request.

Parameters:

headers - map with headers

Returns:

updated builder instance

requestHeader

public T requestHeader(String header,
                       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(String header,
                       List<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(Map<String,List<String>> headers)

Set additional/replacement headers for request.

Parameters:

headers - map with headers

Returns:

updated builder instance

responseHeader

public T responseHeader(String header,
                        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(String header,
                        List<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