Module io.helidon.security.providers.oidc

Package io.helidon.security.providers.oidc

Class OidcProviderService

java.lang.Object

io.helidon.security.providers.oidc.OidcProviderService

All Implemented Interfaces:

SecurityProviderService

public class OidcProviderService
extends Object
implements SecurityProviderService

Java service to create OIDC provider instance.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROVIDER_CONFIG_KEY	The default configuration key expected under security.providers that would contain configuration of a provider instance.

Constructor Summary

Constructors

Constructor	Description
OidcProviderService()

Method Summary

Modifier and Type	Method	Description
Class<? extends SecurityProvider>	providerClass()	Class of the provider of this provider service.
String	providerConfigKey()	Key of the "root" of configuration of this provider.
SecurityProvider	providerInstance(Config config)	Create a new instance of the provider based on the configuration provided.

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER_CONFIG_KEY

public static final String PROVIDER_CONFIG_KEY

The default configuration key expected under security.providers that would contain configuration of a provider instance.

See Also:

Constant Field Values

Constructor Detail

OidcProviderService

public OidcProviderService()

Method Detail

providerConfigKey

public String providerConfigKey()

Description copied from interface: SecurityProviderService

Key of the "root" of configuration of this provider.

Example - Http Signature Provider may use "http-signatures", the configuration in yaml may then be:

 security.providers:
   - http-signatures:
     inbound:
      ....
 

The name of the provider is the same string, unless explicitly defined

Specified by:

providerConfigKey in interface SecurityProviderService

Returns:

name of the configuration key

providerClass

public Class<? extends SecurityProvider> providerClass()

Description copied from interface: SecurityProviderService

Class of the provider of this provider service. The class may be used for cases where configuration requires explicit class name (e.g. when multiple providers use the same configuration key).

Specified by:

providerClass in interface SecurityProviderService

Returns:

class of SecurityProvider provided by this provider service

providerInstance

public SecurityProvider providerInstance(Config config)

Description copied from interface: SecurityProviderService

Create a new instance of the provider based on the configuration provided. The config is located at the config key of this provider.

Specified by:

providerInstance in interface SecurityProviderService

Parameters:

config - Config with provider configuration

Returns:

provider instance created from the Config provided