Package org.keycloak.services.clientpolicy.executor

Class ClientSecretRotationExecutor

java.lang.Object

org.keycloak.services.clientpolicy.executor.ClientSecretRotationExecutor

All Implemented Interfaces:

Provider, ClientPolicyExecutorProvider<ClientSecretRotationExecutor.Configuration>

public class ClientSecretRotationExecutor
extends Object
implements ClientPolicyExecutorProvider<ClientSecretRotationExecutor.Configuration>

Author:

Marcelo Sales

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientSecretRotationExecutor.Configuration

Constructor Summary

Constructors

Constructor	Description
ClientSecretRotationExecutor(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	executeOnEvent(ClientPolicyContext context)	execute actions against the client on the event defined in ClientPolicyEvent.
Class<ClientSecretRotationExecutor.Configuration>	getExecutorConfigurationClass()
String	getProviderId()
void	setupConfiguration(ClientSecretRotationExecutor.Configuration config)	setup this executor's configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProvider

close, getName

Constructor Details

ClientSecretRotationExecutor

public ClientSecretRotationExecutor(KeycloakSession session)

Method Details

getProviderId

public String getProviderId()

Specified by:

getProviderId in interface ClientPolicyExecutorProvider<ClientSecretRotationExecutor.Configuration>

getExecutorConfigurationClass

public Class<ClientSecretRotationExecutor.Configuration> getExecutorConfigurationClass()

Specified by:

getExecutorConfigurationClass in interface ClientPolicyExecutorProvider<ClientSecretRotationExecutor.Configuration>

Returns:

Class, which should match the "config" argument of the ClientPolicyExecutorProvider.setupConfiguration(ClientPolicyExecutorConfigurationRepresentation)

executeOnEvent

public void executeOnEvent(ClientPolicyContext context)
                    throws ClientPolicyException

Description copied from interface: ClientPolicyExecutorProvider

execute actions against the client on the event defined in ClientPolicyEvent.

Specified by:

executeOnEvent in interface ClientPolicyExecutorProvider<ClientSecretRotationExecutor.Configuration>

Parameters:

context - - the context of the event.

Throws:

ClientPolicyException

setupConfiguration

public void setupConfiguration(ClientSecretRotationExecutor.Configuration config)

Description copied from interface: ClientPolicyExecutorProvider

setup this executor's configuration.

Specified by:

setupConfiguration in interface ClientPolicyExecutorProvider<ClientSecretRotationExecutor.Configuration>