Package org.keycloak.services.clientpolicy.executor

Class ClientSecretRotationExecutorFactory

java.lang.Object

org.keycloak.services.clientpolicy.executor.ClientSecretRotationExecutorFactory

All Implemented Interfaces:

ConfiguredProvider, EnvironmentDependentProviderFactory, ProviderFactory<ClientPolicyExecutorProvider>, ClientPolicyExecutorProviderFactory

public class ClientSecretRotationExecutorFactory
extends Object
implements ClientPolicyExecutorProviderFactory, EnvironmentDependentProviderFactory

Author:

Marcelo Sales

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	DEFAULT_SECRET_EXPIRATION_PERIOD
static final Integer	DEFAULT_SECRET_REMAINING_ROTATION_PERIOD
static final Integer	DEFAULT_SECRET_ROTATED_EXPIRATION_PERIOD
static final String	PROVIDER_ID
static final String	SECRET_EXPIRATION_PERIOD
static final String	SECRET_REMAINING_ROTATION_PERIOD
static final String	SECRET_ROTATED_EXPIRATION_PERIOD

Constructor Summary

Constructors

Constructor	Description
ClientSecretRotationExecutorFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
ClientPolicyExecutorProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigProperties()
String	getHelpText()
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

SECRET_EXPIRATION_PERIOD

public static final String SECRET_EXPIRATION_PERIOD

See Also:

• Constant Field Values

DEFAULT_SECRET_EXPIRATION_PERIOD

public static final Integer DEFAULT_SECRET_EXPIRATION_PERIOD

SECRET_REMAINING_ROTATION_PERIOD

public static final String SECRET_REMAINING_ROTATION_PERIOD

See Also:

• Constant Field Values

DEFAULT_SECRET_REMAINING_ROTATION_PERIOD

public static final Integer DEFAULT_SECRET_REMAINING_ROTATION_PERIOD

SECRET_ROTATED_EXPIRATION_PERIOD

public static final String SECRET_ROTATED_EXPIRATION_PERIOD

See Also:

• Constant Field Values

DEFAULT_SECRET_ROTATED_EXPIRATION_PERIOD

public static final Integer DEFAULT_SECRET_ROTATED_EXPIRATION_PERIOD

Constructor Details

ClientSecretRotationExecutorFactory

public ClientSecretRotationExecutorFactory()

Method Details

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

create

public ClientPolicyExecutorProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<ClientPolicyExecutorProvider>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<ClientPolicyExecutorProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<ClientPolicyExecutorProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<ClientPolicyExecutorProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ClientPolicyExecutorProvider>

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface ClientPolicyExecutorProviderFactory

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.