Package org.keycloak.protocol

Interface ProtocolMapper

All Superinterfaces:
org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<ProtocolMapper>
public interface ProtocolMapper extends org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<ProtocolMapper>, org.keycloak.provider.ConfiguredProvider
Version:
$Revision: 1 $
Author:
Bill Burke

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayCategory()
     
    String
    getDisplayType()
     
    default org.keycloak.models.ProtocolMapperModel
    getEffectiveModel(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.ProtocolMapperModel protocolMapperModel)
    Get effective configuration of protocol mapper.
    default int
    getPriority()
    Priority of this protocolMapper implementation.
    String
    getProtocol()
     
    default void
    validateConfig(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.ProtocolMapperContainerModel client, org.keycloak.models.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, dependsOn, 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(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.ProtocolMapperContainerModel client, org.keycloak.models.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 org.keycloak.models.ProtocolMapperModel getEffectiveModel(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.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 -