Package org.keycloak.services.clientpolicy.executor

Interface ClientPolicyExecutorProvider<CONFIG extends ClientPolicyExecutorConfigurationRepresentation>

All Superinterfaces:

Provider

All Known Implementing Classes:

AbstractClientIdMetadataDocumentExecutor, AuthenticationFlowSelectorExecutor, ClientIdMetadataDocumentExecutor, ClientSecretRotationExecutor, ConfidentialClientAcceptExecutor, ConsentRequiredExecutor, CredentialClientPolicyExecutor, DownscopeAssertionGrantEnforcerExecutor, DPoPBindEnforcerExecutor, FullScopeDisabledExecutor, HolderOfKeyEnforcerExecutor, IntentClientBindCheckExecutor, JWTClaimEnforcerExecutor, PKCEEnforcerExecutor, RegistrationAccessTokenRotationDisabledExecutor, RejectImplicitGrantExecutor, RejectRequestExecutor, RejectResourceOwnerPasswordCredentialsGrantExecutor, SamlAvoidRedirectBindingExecutor, SamlSecureClientUrisExecutor, SamlSignatureEnforcerExecutor, SecureCibaAuthenticationRequestSigningAlgorithmExecutor, SecureCibaSessionEnforceExecutor, SecureCibaSignedAuthenticationRequestExecutor, SecureClientAuthenticationAssertionExecutor, SecureClientAuthenticatorExecutor, SecureClientUrisExecutor, SecureClientUrisPatternExecutor, SecureLogoutExecutor, SecureParContentsExecutor, SecureRedirectUrisEnforcerExecutor, SecureRequestObjectExecutor, SecureResponseTypeExecutor, SecureSessionEnforceExecutor, SecureSigningAlgorithmExecutor, SecureSigningAlgorithmForSignedJwtExecutor, SuppressRefreshTokenRotationExecutor, TlsClientAuthCASubjectDNExecutor, 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.

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()