Package org.keycloak.services.clientpolicy.executor

Interface ClientPolicyExecutorProvider<CONFIG extends ClientPolicyExecutorConfigurationRepresentation>

All Superinterfaces:

Provider

All Known Implementing Classes:

ClientSecretRotationExecutor, ConfidentialClientAcceptExecutor, ConsentRequiredExecutor, DPoPBindEnforcerExecutor, FullScopeDisabledExecutor, HolderOfKeyEnforcerExecutor, IntentClientBindCheckExecutor, PKCEEnforcerExecutor, RegistrationAccessTokenRotationDisabledExecutor, RejectImplicitGrantExecutor, RejectRequestExecutor, RejectResourceOwnerPasswordCredentialsGrantExecutor, SecureCibaAuthenticationRequestSigningAlgorithmExecutor, SecureCibaSessionEnforceExecutor, SecureCibaSignedAuthenticationRequestExecutor, SecureClientAuthenticatorExecutor, SecureClientUrisExecutor, SecureLogoutExecutor, SecureParContentsExecutor, SecureRedirectUrisEnforcerExecutor, SecureRequestObjectExecutor, SecureResponseTypeExecutor, SecureSessionEnforceExecutor, SecureSigningAlgorithmExecutor, SecureSigningAlgorithmForSignedJwtExecutor, SuppressRefreshTokenRotationExecutor, UseLightweightAccessTokenExecutor

public interface ClientPolicyExecutorProvider<CONFIG extends ClientPolicyExecutorConfigurationRepresentation>
extends Provider

This executor specifies what action is executed on the client to which a client policy is adopted. The executor can be executed on the events defined in ClientPolicyEvent. It is sufficient for the implementer of this executor to implement methods in which they are interested and isEvaluatedOnEvent method.

Author:

Takashi Norimatsu

Method Summary

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

Method Details

close

default void close()

Specified by:

close in interface Provider

setupConfiguration

default void setupConfiguration(CONFIG config)

setup this executor's configuration.

Parameters:

config -

getExecutorConfigurationClass

default Class<CONFIG> getExecutorConfigurationClass()

Returns:

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

executeOnEvent

default void executeOnEvent(ClientPolicyContext context)
                     throws ClientPolicyException

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

Parameters:

context - - the context of the event.

Throws:

ClientPolicyException

getName

default String getName()

getProviderId

String getProviderId()