Package org.keycloak.protocol
Interface ProtocolMapper
- All Superinterfaces:
ConfiguredProvider
,Provider
,ProviderFactory<ProtocolMapper>
public interface ProtocolMapper
extends Provider, ProviderFactory<ProtocolMapper>, ConfiguredProvider
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Method Summary
Modifier and TypeMethodDescriptiondefault int
Priority of this protocolMapper implementation.default void
validateConfig
(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) Called when instance of mapperModel is created/updated for this protocolMapper through admin endpointMethods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig, getConfigProperties, getHelpText
Methods inherited from interface org.keycloak.provider.ProviderFactory
close, create, getConfigMetadata, getId, init, order, postInit
-
Method Details
-
getProtocol
String getProtocol() -
getDisplayCategory
String getDisplayCategory() -
getDisplayType
String getDisplayType() -
getPriority
default int getPriority()Priority of this protocolMapper implementation. Lower goes first.- Returns:
-
validateConfig
default void validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) throws ProtocolMapperConfigException Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint- Parameters:
session
-realm
-client
- client or clientTemplatemapperModel
-- Throws:
ProtocolMapperConfigException
- if configuration provided in mapperModel is not valid
-