Module io.helidon.security.providers.config.vault

Package io.helidon.security.providers.config.vault

Class ConfigVaultProviderService

java.lang.Object

io.helidon.security.providers.config.vault.ConfigVaultProviderService

All Implemented Interfaces:

SecurityProviderService

public class ConfigVaultProviderService
extends Object
implements SecurityProviderService

Java Service Loader implementation of a SecurityProviderService provider service. Do not instantiate directly.

Constructor Summary

Constructors

Constructor	Description
ConfigVaultProviderService()	Deprecated. do not use, this should only be invoked by Java Service Loader

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.security.spi.SecurityProviderService

providerInstance

Constructor Details

ConfigVaultProviderService

@Deprecated
public ConfigVaultProviderService()

Deprecated.

do not use, this should only be invoked by Java Service Loader

See Also:

• ConfigVaultProvider

Method Details

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

create

public SecurityProvider create(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.

API Note: the default method implementation is provided for backward compatibility and will be removed in the next major version

Specified by:

create in interface SecurityProviderService

Parameters:

config - Config with provider configuration

Returns:

provider instance created from the Config provided