Module io.helidon.security.providers.oidc

Package io.helidon.security.providers.oidc

Class OidcSupport.Builder

java.lang.Object

io.helidon.security.providers.oidc.OidcSupport.Builder

All Implemented Interfaces:

Builder<OidcSupport>, Supplier<OidcSupport>

Enclosing class:

OidcSupport

public static class OidcSupport.Builder
extends Object
implements Builder<OidcSupport>

A fluent API builder for OidcSupport.

Method Summary

Modifier and Type	Method	Description
OidcSupport.Builder	addTenantConfigFinder(TenantConfigFinder configFinder)	Add specific TenantConfigFinder implementation.
OidcSupport.Builder	addTenantConfigFinder(TenantConfigFinder configFinder, int priority)	Add specific TenantConfigFinder implementation with specific priority.
OidcSupport	build()	Build the instance from this builder.
OidcSupport.Builder	config(Config config)	Config located at the provider's key to read OidcConfig.
OidcSupport.Builder	config(Config config, String providerName)	Config located either at the configuration root, or at the provider node.
OidcSupport.Builder	config(OidcConfig config)	Use the provided OidcConfig for this builder.
OidcSupport.Builder	discoverTenantConfigProviders(boolean discoverConfigProviders)	Whether to allow TenantConfigProvider service loader discovery.
OidcSupport.Builder	enabled(boolean enabled)	You can disable the OIDC support in case it should not be used.

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 OidcSupport build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OidcSupport>

Returns:

instance of the built type

config

public OidcSupport.Builder config(Config config)

Config located at the provider's key to read OidcConfig.

Parameters:

config - configuration at the node of the provider

Returns:

updated builder instance

config

public OidcSupport.Builder config(OidcConfig config)

Use the provided OidcConfig for this builder.

Parameters:

config - OIDC configuration to use

Returns:

updated builder instance

config

public OidcSupport.Builder config(Config config,
                                  String providerName)

Config located either at the configuration root, or at the provider node.

Parameters:

config - configuration to use

providerName - name of the security provider used for the OidcSupport configuration

Returns:

updated builder instance

enabled

public OidcSupport.Builder enabled(boolean enabled)

You can disable the OIDC support in case it should not be used. This can also be achieved through configuration, by setting security.enabled to false when using root configuration, or by setting enabled to false when using provider configuration node.

Parameters:

enabled - whether the support should be enabled or not

Returns:

updated builder instance

discoverTenantConfigProviders

public OidcSupport.Builder discoverTenantConfigProviders(boolean discoverConfigProviders)

Whether to allow TenantConfigProvider service loader discovery. Default value is true.

Parameters:

discoverConfigProviders - whether to use service loader

Returns:

updated builder instance

addTenantConfigFinder

public OidcSupport.Builder addTenantConfigFinder(TenantConfigFinder configFinder)

Add specific TenantConfigFinder implementation. Priority BUILDER_PRIORITY is used.

Parameters:

configFinder - config finder implementation

Returns:

updated builder instance

addTenantConfigFinder

public OidcSupport.Builder addTenantConfigFinder(TenantConfigFinder configFinder,
                                                 int priority)

Add specific TenantConfigFinder implementation with specific priority.

Parameters:

configFinder - config finder implementation

priority - finder priority

Returns:

updated builder instance