Class ConsentRequiredExecutor
- java.lang.Object
-
- org.keycloak.services.clientpolicy.executor.ConsentRequiredExecutor
-
- All Implemented Interfaces:
Provider
,ClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>
public class ConsentRequiredExecutor extends Object implements ClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>
- Author:
- Takashi Norimatsu
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ConsentRequiredExecutor.Configuration
-
Constructor Summary
Constructors Constructor Description ConsentRequiredExecutor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beforeUpdate(ClientModel clientToBeUpdated, ClientRepresentation proposedClient)
void
executeOnEvent(ClientPolicyContext context)
execute actions against the client on the event defined inClientPolicyEvent
.Class<ConsentRequiredExecutor.Configuration>
getExecutorConfigurationClass()
String
getProviderId()
void
setupConfiguration(ConsentRequiredExecutor.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
-
-
-
-
Method Detail
-
executeOnEvent
public void executeOnEvent(ClientPolicyContext context) throws ClientPolicyException
Description copied from interface:ClientPolicyExecutorProvider
execute actions against the client on the event defined inClientPolicyEvent
.- Specified by:
executeOnEvent
in interfaceClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>
- Parameters:
context
- - the context of the event.- Throws:
ClientPolicyException
-
setupConfiguration
public void setupConfiguration(ConsentRequiredExecutor.Configuration config)
Description copied from interface:ClientPolicyExecutorProvider
setup this executor's configuration.- Specified by:
setupConfiguration
in interfaceClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>
-
getExecutorConfigurationClass
public Class<ConsentRequiredExecutor.Configuration> getExecutorConfigurationClass()
- Specified by:
getExecutorConfigurationClass
in interfaceClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>
- Returns:
- Class, which should match the "config" argument of the
ClientPolicyExecutorProvider.setupConfiguration(ClientPolicyExecutorConfigurationRepresentation)
-
getProviderId
public String getProviderId()
- Specified by:
getProviderId
in interfaceClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>
-
beforeUpdate
public void beforeUpdate(ClientModel clientToBeUpdated, ClientRepresentation proposedClient) throws ClientPolicyException
- Throws:
ClientPolicyException
-
-