Class OutboundSecurityClientBuilder

java.lang.Object

io.helidon.security.SecurityRequestBuilder<OutboundSecurityClientBuilder>

io.helidon.security.OutboundSecurityClientBuilder

All Implemented Interfaces:

Builder<OutboundSecurityClientBuilder, SecurityClient<OutboundSecurityResponse>>, Supplier<SecurityClient<OutboundSecurityResponse>>

public class OutboundSecurityClientBuilder
extends SecurityRequestBuilder<OutboundSecurityClientBuilder>
implements Builder<OutboundSecurityClientBuilder, SecurityClient<OutboundSecurityResponse>>

Builder constructing a security client - extends the SecurityRequestBuilder for convenience.

Method Summary

Modifier and Type	Method	Description
SecurityClient<OutboundSecurityResponse>	build()	Build an instance of a security client.
OutboundSecurityResponse	buildAndGet()	A shortcut method to build the client and invoke SecurityClient.get() on it.
OutboundSecurityClientBuilder	outboundEndpointConfig(EndpointConfig outboundEndpointConfig)	Configure outbound endpoint config (annotations, config, attributes etc.) for this outbound call.
OutboundSecurityClientBuilder	outboundEndpointConfig(Supplier<EndpointConfig> outboundEndpointConfig)	Configure outbound endpoint config (annotations, config, attributes etc.) for this outbound call.
OutboundSecurityClientBuilder	outboundEnvironment(SecurityEnvironment outboundEnvironment)	Configure outbound environment (path, headers, URI etc.) for this outbound call.
OutboundSecurityClientBuilder	outboundEnvironment(Supplier<SecurityEnvironment> outboundEnvironment)	Configure outbound environment (path, headers, URI etc.) for this outbound call.
OutboundSecurityClientBuilder	securityContext(SecurityContext context)	Configure the security context representing the request for which outbound security is invoked.
OutboundSecurityResponse	submit()	A shortcut method to build the client and invoke SecurityClient.submit() on it.

Methods inherited from class SecurityRequestBuilder

buildRequest, explicitProvider, object, object, object, object, optional, tracingSpan

Modifier and Type	Method	Description
SecurityRequest	buildRequest()	Build the security request.
OutboundSecurityClientBuilder	explicitProvider(String providerName)	Use an explicit provider.
OutboundSecurityClientBuilder	object(Object resource)	Put object to this request.
OutboundSecurityClientBuilder	object(String key, Object object)	Bind object to a specific name.
OutboundSecurityClientBuilder	object(String key, Supplier<Object> object)	Bind object supplier to a specific name.
OutboundSecurityClientBuilder	object(Supplier<Object> resource)	Put object supplier to this request.
OutboundSecurityClientBuilder	optional(boolean optional)	Set that security is optional.
OutboundSecurityClientBuilder	tracingSpan(SpanContext spanContext)	Tracing span to support Open tracing.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default SecurityClient<OutboundSecurityResponse>	get()
default OutboundSecurityClientBuilder	identity()	Instance of this builder as the correct type.
default OutboundSecurityClientBuilder	update(Consumer<OutboundSecurityClientBuilder> consumer)	Update the builder in a fluent API way.

Method Details

build

public SecurityClient<OutboundSecurityResponse> build()

Build an instance of a security client. The client is immutable.

Specified by:

build in interface Builder<OutboundSecurityClientBuilder, SecurityClient<OutboundSecurityResponse>>

Returns:

client instance

outboundEnvironment

public OutboundSecurityClientBuilder outboundEnvironment(SecurityEnvironment outboundEnvironment)

Configure outbound environment (path, headers, URI etc.) for this outbound call.

Parameters:

outboundEnvironment - environment to use for outbound call

Returns:

updated builder instance

outboundEnvironment

public OutboundSecurityClientBuilder outboundEnvironment(Supplier<SecurityEnvironment> outboundEnvironment)

Configure outbound environment (path, headers, URI etc.) for this outbound call.

Parameters:

outboundEnvironment - environment builder to use for outbound call

Returns:

updated builder instance

outboundEndpointConfig

public OutboundSecurityClientBuilder outboundEndpointConfig(EndpointConfig outboundEndpointConfig)

Configure outbound endpoint config (annotations, config, attributes etc.) for this outbound call.

Parameters:

outboundEndpointConfig - endpoint config to use for outbound call

Returns:

updated builder instance

outboundEndpointConfig

public OutboundSecurityClientBuilder outboundEndpointConfig(Supplier<EndpointConfig> outboundEndpointConfig)

Configure outbound endpoint config (annotations, config, attributes etc.) for this outbound call.

Parameters:

outboundEndpointConfig - endpoint config builder to use for outbound call

Returns:

updated builder instance

securityContext

public OutboundSecurityClientBuilder securityContext(SecurityContext context)

Configure the security context representing the request for which outbound security is invoked. The context provides the current user and service subjects to outbound security providers. Provider selection is still controlled by the Security instance that created this builder.

Parameters:

context - security context of the current request

Returns:

updated builder instance

buildAndGet

public OutboundSecurityResponse buildAndGet()

A shortcut method to build the client and invoke SecurityClient.get() on it.

Returns:

SecurityResponse of expected type

submit

public OutboundSecurityResponse submit()

A shortcut method to build the client and invoke SecurityClient.submit() on it.

Returns:

SecurityResponse of expected type