Package org.keycloak.services.clientpolicy.executor

Interface ClientPolicyExecutorProvider<CONFIG extends org.keycloak.representations.idm.ClientPolicyExecutorConfigurationRepresentation>

All Superinterfaces:
org.keycloak.provider.Provider
public interface ClientPolicyExecutorProvider<CONFIG extends org.keycloak.representations.idm.ClientPolicyExecutorConfigurationRepresentation> extends org.keycloak.provider.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 Details

    • close

      default void close()
      Specified by:
      close in interface org.keycloak.provider.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(org.keycloak.services.clientpolicy.ClientPolicyContext context) throws org.keycloak.services.clientpolicy.ClientPolicyException
      execute actions against the client on the event defined in ClientPolicyEvent.
      Parameters:
      context - - the context of the event.
      Throws:
      org.keycloak.services.clientpolicy.ClientPolicyException

    • getName

      default String getName()

    • getProviderId

      String getProviderId()