org.keycloak.services.clientpolicy.executor

Interface ClientPolicyExecutorProvider

All Superinterfaces:

Provider

public interface ClientPolicyExecutorProvider
extends Provider

This executor specifies what action is executed on the client to which ClientPolicyProvider 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.

Method Summary

Modifier and Type	Method and Description
default void	close()
default void	executeOnEvent(ClientPolicyContext context) execute actions against the client on the event defined in ClientPolicyEvent.
String	getName()
String	getProviderId()

Method Detail

close

default void close()

Specified by:

close in interface Provider

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:

{@link - ClientPolicyException} - if something wrong happens when execution actions.

ClientPolicyException

getName

String getName()

getProviderId

String getProviderId()