Package org.keycloak.services.clientpolicy.condition

Interface ClientPolicyConditionProviderFactory

All Superinterfaces:

ConfiguredProvider, EnvironmentDependentProviderFactory, ProviderFactory<ClientPolicyConditionProvider>

All Known Implementing Classes:

AbstractClientPolicyConditionProviderFactory, AcrConditionFactory, AnyClientConditionFactory, ClientAccessTypeConditionFactory, ClientAttributesConditionFactory, ClientProtocolConditionFactory, ClientRolesConditionFactory, ClientScopesConditionFactory, ClientUpdaterContextConditionFactory, ClientUpdaterSourceGroupsConditionFactory, ClientUpdaterSourceHostsConditionFactory, ClientUpdaterSourceRolesConditionFactory, GrantTypeConditionFactory

public interface ClientPolicyConditionProviderFactory
extends ProviderFactory<ClientPolicyConditionProvider>, ConfiguredProvider, EnvironmentDependentProviderFactory

Author:

Takashi Norimatsu

Method Summary

Modifier and Type	Method	Description
default boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
default void	validateConfiguration(KeycloakSession session, RealmModel realm, ClientPolicyConditionRepresentation conditionRepresentation)	Called before a Client Policy is created or updated.

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

close, create, dependsOn, getConfigMetadata, getId, init, order, postInit

Method Details

isSupported

default boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

validateConfiguration

default void validateConfiguration(KeycloakSession session,
 RealmModel realm,
 ClientPolicyConditionRepresentation conditionRepresentation)
                            throws ClientPolicyException

Called before a Client Policy is created or updated. Allows you to validate the configuration

Parameters:

session -

realm -

conditionRepresentation -

Throws:

ClientPolicyException