Package org.keycloak.protocol.saml

Class SamlProtocolFactory

java.lang.Object
org.keycloak.protocol.AbstractLoginProtocolFactory
org.keycloak.protocol.saml.SamlProtocolFactory
All Implemented Interfaces:
org.keycloak.protocol.LoginProtocolFactory, org.keycloak.provider.ProviderFactory<org.keycloak.protocol.LoginProtocol>
public class SamlProtocolFactory extends org.keycloak.protocol.AbstractLoginProtocolFactory
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    SCOPE_AUTHN_CONTEXT_CLASS_REF
     
    static final String
    SCOPE_ROLE_LIST
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SamlProtocolFactory()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addDefaults(org.keycloak.models.ClientModel client)
     
    org.keycloak.models.ClientScopeModel
    addSamlAuthnContextClassRefClientScope(org.keycloak.models.RealmModel newRealm)
     
    org.keycloak.protocol.LoginProtocol
    create(org.keycloak.models.KeycloakSession session)
     
    protected void
    createDefaultClientScopesImpl(org.keycloak.models.RealmModel newRealm)
     
    Object
    createProtocolEndpoint(org.keycloak.models.KeycloakSession session, org.keycloak.events.EventBuilder event)
     
    Map<String,org.keycloak.models.ProtocolMapperModel>
    getBuiltinMappers()
     
    List<org.keycloak.provider.ProviderConfigProperty>
    getConfigMetadata()
     
    String
    getId()
     
    long
    getMaxInflatingSize()
    Getter for the max inflating size
    void
    init(org.keycloak.Config.Scope config)
     
    int
    order()
    defines the option-order in the admin-ui
    void
    setupClientDefaults(org.keycloak.representations.idm.ClientRepresentation clientRep, org.keycloak.models.ClientModel newClient)
     

    Methods inherited from class org.keycloak.protocol.AbstractLoginProtocolFactory

    addClientScopeDefaults, addDefaultClientScopes, addDefaultClientScopes, close, createDefaultClientScopes, postInit

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.keycloak.protocol.LoginProtocolFactory

    allowAsClientProtocol, isValidClientScope, onConsentRevoked, validateClientScope, validateClientScopeAssignment

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn

  • Field Details

  • Constructor Details

    • SamlProtocolFactory

      public SamlProtocolFactory()

  • Method Details

    • createProtocolEndpoint

      public Object createProtocolEndpoint(org.keycloak.models.KeycloakSession session, org.keycloak.events.EventBuilder event)

    • create

      public org.keycloak.protocol.LoginProtocol create(org.keycloak.models.KeycloakSession session)

    • init

      public void init(org.keycloak.Config.Scope config)
      Specified by:
      init in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.LoginProtocol>
      Overrides:
      init in class org.keycloak.protocol.AbstractLoginProtocolFactory

    • getId

      public String getId()

    • getBuiltinMappers

      public Map<String,org.keycloak.models.ProtocolMapperModel> getBuiltinMappers()

    • createDefaultClientScopesImpl

      protected void createDefaultClientScopesImpl(org.keycloak.models.RealmModel newRealm)
      Specified by:
      createDefaultClientScopesImpl in class org.keycloak.protocol.AbstractLoginProtocolFactory

    • addDefaults

      protected void addDefaults(org.keycloak.models.ClientModel client)
      Specified by:
      addDefaults in class org.keycloak.protocol.AbstractLoginProtocolFactory

    • setupClientDefaults

      public void setupClientDefaults(org.keycloak.representations.idm.ClientRepresentation clientRep, org.keycloak.models.ClientModel newClient)

    • order

      public int order()
      defines the option-order in the admin-ui

    • getMaxInflatingSize

      public long getMaxInflatingSize()
      Getter for the max inflating size
      Returns:

    • getConfigMetadata

      public List<org.keycloak.provider.ProviderConfigProperty> getConfigMetadata()

    • addSamlAuthnContextClassRefClientScope

      public org.keycloak.models.ClientScopeModel addSamlAuthnContextClassRefClientScope(org.keycloak.models.RealmModel newRealm)