Module io.helidon.security.providers.oidc.common

Package io.helidon.security.providers.oidc.common

Interface ClientCredentialsConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ClientCredentialsConfig.BuilderBase.ClientCredentialsConfigImpl

public interface ClientCredentialsConfig
extends Prototype.Api

Configuration of the OIDC client credentials flow.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ClientCredentialsConfig.Builder	Fluent API builder for ClientCredentialsConfig.
static class	ClientCredentialsConfig.BuilderBase<BUILDER extends ClientCredentialsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClientCredentialsConfig>	Fluent API builder base for ClientCredentialsConfig.

Method Summary

Modifier and Type	Method	Description
static ClientCredentialsConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ClientCredentialsConfig.Builder	builder(ClientCredentialsConfig instance)	Create a new fluent API builder from an existing instance.
static ClientCredentialsConfig	create()	Create a new instance with default values.
static ClientCredentialsConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static ClientCredentialsConfig	create(Config config)	Create a new instance from configuration.
Optional<String>	scope()	Scope used when obtaining access token in the client credentials flow.

Method Details

builder

static ClientCredentialsConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ClientCredentialsConfig.Builder builder(ClientCredentialsConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ClientCredentialsConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

@Deprecated
static ClientCredentialsConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static ClientCredentialsConfig create()

Create a new instance with default values.

Returns:

a new instance

scope

Optional<String> scope()

Scope used when obtaining access token in the client credentials flow. It is required to set when server-type is set to idcs.

Returns:

client credentials scope