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

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

Class ClientCredentialsConfig.BuilderBase<BUILDER extends ClientCredentialsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClientCredentialsConfig>

java.lang.Object

io.helidon.security.providers.oidc.common.ClientCredentialsConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

ClientCredentialsConfig.Builder

Enclosing interface:

ClientCredentialsConfig

public abstract static class ClientCredentialsConfig.BuilderBase<BUILDER extends ClientCredentialsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClientCredentialsConfig>
extends Object
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for ClientCredentialsConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ClientCredentialsConfig.BuilderBase.ClientCredentialsConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	clearScope()	Clear existing value of this property.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(ClientCredentialsConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(ClientCredentialsConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<String>	scope()	Scope used when obtaining access token in the client credentials flow.
BUILDER	scope(String scope)	Scope used when obtaining access token in the client credentials flow.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(ClientCredentialsConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(ClientCredentialsConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends ClientCredentialsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClientCredentialsConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends ClientCredentialsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClientCredentialsConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

clearScope

public BUILDER clearScope()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• scope()

scope

public BUILDER scope(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.

Parameters:

scope - client credentials scope

Returns:

updated builder instance

See Also:

• scope()

scope

public 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:

the scope

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class Object

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

validatePrototype

protected void validatePrototype()

Validates required properties.