Package io.helidon.security

Class EndpointConfig.Builder

java.lang.Object

io.helidon.security.EndpointConfig.Builder

All Implemented Interfaces:

Builder<EndpointConfig>, Supplier<EndpointConfig>

Enclosing class:

EndpointConfig

public static final class EndpointConfig.Builder
extends Object
implements Builder<EndpointConfig>

A fluent API builder for EndpointConfig.

Method Summary

Modifier and Type	Method	Description
EndpointConfig.Builder	addAtribute(String key, Object value)	Add an attribute to this endpoint configuration builder.
EndpointConfig.Builder	annotations(EndpointConfig.AnnotationScope scope, Map<Class<? extends Annotation>,List<Annotation>> annotations)	Deprecated. Use the securityLevels method.
EndpointConfig	build()	Build the instance from this builder.
EndpointConfig.Builder	config(String configKey, Config configuration)	Provide a configuration for provider to use.
EndpointConfig.Builder	configMap(Map<String,Config> configMap)	Provider a map of cofiguration keys to configurations for provider(s) to use.
<U,V extends U> EndpointConfig.Builder	customObject(Class<U> objectClass, V anObject)	Set or replace a custom object.
EndpointConfig.Builder	customObjects(ClassToInstanceStore<Object> customObjects)	Provide custom object map to be sent to security providers.
EndpointConfig.Builder	securityLevels(List<SecurityLevel> securityLevels)	Sets security levels to this endpoint configuration builder.

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

build

public EndpointConfig build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<EndpointConfig>

Returns:

instance of the built type

customObject

public <U,V extends U> EndpointConfig.Builder customObject(Class<U> objectClass,
                                                                 V anObject)

Set or replace a custom object. This object will be provided to security provider. Objects are stored by class, so we can have multiple objects of different classes (e.g. when using multiple authorizers/authenticators). Class of object is defined by security provider.

Type Parameters:

U - Type of the custom object to be stored. The object instance is available ONLY under this class

V - Type of instance (must be descendant of U)

Parameters:

objectClass - Class of object as expected by security provider

anObject - Custom object to propagate to security provider

Returns:

updated Builder instance

customObjects

public EndpointConfig.Builder customObjects(ClassToInstanceStore<Object> customObjects)

Provide custom object map to be sent to security providers.

Parameters:

customObjects - Class to its instance map of custom objects

Returns:

Updated builder instance

See Also:

customObject(Class, Object)

config

public EndpointConfig.Builder config(String configKey,
                                     Config configuration)

Provide a configuration for provider to use. This allows a provider to define a custom configuration key.

Parameters:

configKey - key this configuration is stored under

configuration - configuration stored under the key, as expected by security provider

Returns:

Updated builder instance

configMap

public EndpointConfig.Builder configMap(Map<String,Config> configMap)

Provider a map of cofiguration keys to configurations for provider(s) to use.

Parameters:

configMap - map of configurations

Returns:

updated builder instance

annotations

@Deprecated
public EndpointConfig.Builder annotations(EndpointConfig.AnnotationScope scope,
                                          Map<Class<? extends Annotation>,List<Annotation>> annotations)

Deprecated.

Use the securityLevels method.

Add annotations of a specific scope to this request builder. Only used by frameworks that use annotations.

Parameters:

scope - Annotation scope to add annotations for

annotations - Collected annotations based on security provider requirements.

Returns:

updated Builder instance

addAtribute

public EndpointConfig.Builder addAtribute(String key,
                                          Object value)

Add an attribute to this endpoint configuration builder.

Parameters:

key - name of the attribute as expected by the security provider

value - value of this attribute

Returns:

updated builder instance

securityLevels

public EndpointConfig.Builder securityLevels(List<SecurityLevel> securityLevels)

Sets security levels to this endpoint configuration builder.

Parameters:

securityLevels - list of security levels

Returns:

updated builder instance