Package io.helidon.security

Class SecurityRequestBuilder<T extends SecurityRequestBuilder>

java.lang.Object

io.helidon.security.SecurityRequestBuilder<T>

Type Parameters:

T - Type of the builder, used to enable extensibility of this builder

Direct Known Subclasses:

OutboundSecurityClientBuilder, SecurityClientBuilder

public class SecurityRequestBuilder<T extends SecurityRequestBuilder>
extends java.lang.Object

Fluent API to build a security request.

Method Summary

Modifier and Type	Method and Description
SecurityRequest	buildRequest() Build the security request.
T	explicitProvider(java.lang.String providerName) Use an explicit provider.
T	object(java.lang.Object resource) Put object to this request.
T	object(java.lang.String key, java.lang.Object object) Bind object to a specific name.
T	object(java.lang.String key, java.util.function.Supplier<java.lang.Object> object) Bind object supplier to a specific name.
T	object(java.util.function.Supplier<java.lang.Object> resource) Put object supplier to this request.
T	optional(boolean optional) Set that security is optional.
T	requestMessage(Entity entity) Set the request message to use when security provider requires access to it.
T	responseMessage(Entity entity) Set the response message to use when security provider requires access to it.
T	tracingSpan(Span span) Tracing span to support Open tracing.

Methods inherited from class java.lang.Object

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

Method Detail

object

public T object(java.lang.Object resource)

Put object to this request. Creates a default mapping to name "object".

Parameters:

resource - resource instance to be available to security provider

Returns:

updated builder instance

object

public T object(java.util.function.Supplier<java.lang.Object> resource)

Put object supplier to this request. Creates a default mapping to name "object".

Parameters:

resource - supplier of resource instance to be available to security provider

Returns:

updated builder instance

object

public T object(java.lang.String key,
                java.lang.Object object)

Bind object to a specific name. Example: a security policy for move operation expects source object bound to "object" and target object bound to "target" you could achieve this by calling object(sourceInstance) to bind the "object" part of the statement and object("target", targetInstance) to bind the "target" part of the statement

Parameters:

key - key to bind this object under

object - resource instance

Returns:

updated builder instance

object

public T object(java.lang.String key,
                java.util.function.Supplier<java.lang.Object> object)

Bind object supplier to a specific name. Example: a security policy for move operation expects source object bound to "object" and target object bound to "target" you could achieve this by calling object(sourceInstance) to bind the "object" part of the statement and object("target", targetInstance) to bind the "target" part of the statement

Parameters:

key - key to bind this object under

object - supplier of resource instance

Returns:

updated builder instance

tracingSpan

public T tracingSpan(Span span)

Tracing span to support Open tracing. Provider developer can add additional spans as children of this span to trace their progress.

Parameters:

span - span of current security request (e.g. authentication, authorization or outbound)

Returns:

updated builder instance

See Also:

GlobalTracer.get(), Tracer.buildSpan(String)

explicitProvider

public T explicitProvider(java.lang.String providerName)

Use an explicit provider.

Parameters:

providerName - Name of a configured SecurityProvider

Returns:

updated request builder instance

optional

public T optional(boolean optional)

Set that security is optional. Required is default.

Parameters:

optional - set to true to make this security request optional

Returns:

this instance

requestMessage

public T requestMessage(Entity entity)

Set the request message to use when security provider requires access to it.

Parameters:

entity - Message to use, may be null (e.g. for requests without entity)

Returns:

updated builder instance

responseMessage

public T responseMessage(Entity entity)

Set the response message to use when security provider requires access to it.

Parameters:

entity - Message to use, may be null (e.g. for responses without entity)

Returns:

updated builder instance

buildRequest

public SecurityRequest buildRequest()

Build the security request. Not using name "build" on purpose, so overriding classes can build their expected type.

Returns:

Security request built from this builder.