Package org.keycloak.protocol

Interface ProtocolMapper

All Superinterfaces:

ConfiguredProvider, Provider, ProviderFactory<ProtocolMapper>

All Known Implementing Classes:

AbstractOIDCProtocolMapper, AbstractPairwiseSubMapper, AbstractSAMLProtocolMapper, AcrProtocolMapper, AddressMapper, AllowAllDockerProtocolMapper, AllowedWebOriginsProtocolMapper, AmrProtocolMapper, AudienceProtocolMapper, AudienceResolveProtocolMapper, ClaimsParameterTokenMapper, ClaimsParameterWithValueIdTokenMapper, DeployedScriptOIDCProtocolMapper, DeployedScriptSAMLProtocolMapper, DockerAuthV2ProtocolMapper, FullNameMapper, GroupMembershipMapper, GroupMembershipMapper, HardcodedAttributeMapper, HardcodedClaim, HardcodedRole, HardcodedRole, NonceBackwardsCompatibleMapper, OID4VCContextMapper, OID4VCMapper, OID4VCStaticClaimMapper, OID4VCSubjectIdMapper, OID4VCTargetRoleMapper, OID4VCTypeMapper, OID4VCUserAttributeMapper, OrganizationMembershipMapper, OrganizationMembershipMapper, RoleListMapper, RoleNameMapper, RoleNameMapper, SAMLAudienceProtocolMapper, SAMLAudienceResolveProtocolMapper, ScriptBasedMapper, ScriptBasedOIDCProtocolMapper, SessionStateMapper, SHA256PairwiseSubMapper, SubMapper, UserAttributeMapper, UserAttributeNameIdMapper, UserAttributeStatementMapper, UserClientRoleMappingMapper, UserPropertyAttributeStatementMapper, UserPropertyMapper, UserRealmRoleMappingMapper, UserSessionNoteMapper, UserSessionNoteStatementMapper

public interface ProtocolMapper
extends Provider, ProviderFactory<ProtocolMapper>, ConfiguredProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method	Description
String	getDisplayCategory()
String	getDisplayType()
default ProtocolMapperModel	getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)	Get effective configuration of protocol mapper.
default int	getPriority()	Priority of this protocolMapper implementation.
String	getProtocol()
default void	validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel)	Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.provider.Provider

close

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 clientTemplate

mapperModel -

Throws:

ProtocolMapperConfigException - if configuration provided in mapperModel is not valid

getEffectiveModel

default ProtocolMapperModel getEffectiveModel(KeycloakSession session,
 RealmModel realm,
 ProtocolMapperModel protocolMapperModel)

Get effective configuration of protocol mapper. Effective configuration takes "default values" of the options into consideration and hence it is the configuration, which would be actually used when processing this protocolMapper during issuing tokens/assertions. So for instance, when configuration option "introspection.token.claim" is unset in the protocolMapperModel, but default value of this option is supposed to be "true", then effective config returned by this method will contain "introspection.token.claim" config option with value "true" . If the "introspection.token.claim" is set, then the default value is typically ignored in the effective configuration, but this can depend on the implementation of particular protocol mapper.

Parameters:

session -

realm -

protocolMapperModel -