Package org.keycloak.services.clientpolicy.executor

Class AllowedProtocolMappersExecutor

java.lang.Object

org.keycloak.services.clientpolicy.executor.AllowedProtocolMappersExecutor

All Implemented Interfaces:

Provider, ClientPolicyExecutorProvider<AllowedProtocolMappersExecutor.Configuration>

public class AllowedProtocolMappersExecutor
extends Object
implements ClientPolicyExecutorProvider<AllowedProtocolMappersExecutor.Configuration>

Checks protocol mapper types and configurations changed through the Admin REST API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AllowedProtocolMappersExecutor.Configuration

Constructor Summary

Constructors

Constructor	Description
AllowedProtocolMappersExecutor(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	executeOnEvent(ClientPolicyContext context)	execute actions against the client on the event defined in ClientPolicyEvent.
Class<AllowedProtocolMappersExecutor.Configuration>	getExecutorConfigurationClass()
String	getProviderId()
void	setupConfiguration(AllowedProtocolMappersExecutor.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 Details

AllowedProtocolMappersExecutor

public AllowedProtocolMappersExecutor(KeycloakSession session)

Method Details

setupConfiguration

public void setupConfiguration(AllowedProtocolMappersExecutor.Configuration config)

Description copied from interface: ClientPolicyExecutorProvider

setup this executor's configuration.

Specified by:

setupConfiguration in interface ClientPolicyExecutorProvider<AllowedProtocolMappersExecutor.Configuration>

getExecutorConfigurationClass

public Class<AllowedProtocolMappersExecutor.Configuration> getExecutorConfigurationClass()

Specified by:

getExecutorConfigurationClass in interface ClientPolicyExecutorProvider<AllowedProtocolMappersExecutor.Configuration>

Returns:

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

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<AllowedProtocolMappersExecutor.Configuration>

Parameters:

context - - the context of the event.

Throws:

ClientPolicyException

getProviderId

public String getProviderId()

Specified by:

getProviderId in interface ClientPolicyExecutorProvider<AllowedProtocolMappersExecutor.Configuration>