Package org.keycloak.services.clientpolicy.executor

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

Modifier and Type	Method	Description
void	beforeUpdate(ClientModel clientToBeUpdated, ClientRepresentation proposedClient)
void	executeOnEvent(ClientPolicyContext context)	execute actions against the client on the event defined in ClientPolicyEvent.
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

Constructor Detail

ConsentRequiredExecutor

public ConsentRequiredExecutor()

Method Detail

executeOnEvent

public void executeOnEvent(ClientPolicyContext context)
                    throws ClientPolicyException

Description copied from interface: ClientPolicyExecutorProvider

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

Specified by:

executeOnEvent in interface ClientPolicyExecutorProvider<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 interface ClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>

getExecutorConfigurationClass

public Class<ConsentRequiredExecutor.Configuration> getExecutorConfigurationClass()

Specified by:

getExecutorConfigurationClass in interface ClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>

Returns:

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

getProviderId

public String getProviderId()

Specified by:

getProviderId in interface ClientPolicyExecutorProvider<ConsentRequiredExecutor.Configuration>

beforeUpdate

public void beforeUpdate(ClientModel clientToBeUpdated,
                         ClientRepresentation proposedClient)
                  throws ClientPolicyException

Throws:

ClientPolicyException