Module io.helidon.security
Package io.helidon.security.spi

Interface SecurityProviderService

All Known Implementing Classes:
AbacProviderService, ConfigVaultProviderService, CubbyholeSecurityService, GoogleTokenService, HeaderAtnService, HttpBasicAuthService, HttpDigestAuthService, HttpSignService, IdcsRoleMapperProviderService, JwtAuthProviderService, JwtProviderService, Kv1SecurityService, Kv2SecurityService, OidcProviderService, TransitSecurityService
public interface SecurityProviderService
Service to use with ServiceLoader to map configuration to provider.

  • Method Details

    • providerConfigKey

      String providerConfigKey()
      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
      Returns:
      name of the configuration key

    • providerClass

      Class<? extends SecurityProvider> providerClass()
      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).
      Returns:
      class of SecurityProvider provided by this provider service

    • providerInstance

      SecurityProvider providerInstance(Config config)
      Create a new instance of the provider based on the configuration provided. The config is located at the config key of this provider.
      Parameters:
      config - Config with provider configuration
      Returns:
      provider instance created from the Config provided