Class OIDCLoginProtocolFactory

java.lang.Object
org.keycloak.protocol.AbstractLoginProtocolFactory
org.keycloak.protocol.oidc.OIDCLoginProtocolFactory
All Implemented Interfaces:
org.keycloak.protocol.LoginProtocolFactory, org.keycloak.provider.ProviderFactory<org.keycloak.protocol.LoginProtocol>

public class OIDCLoginProtocolFactory extends org.keycloak.protocol.AbstractLoginProtocolFactory
Version:
$Revision: 1 $
Author:
Bill Burke
  • Field Details

  • Constructor Details

    • OIDCLoginProtocolFactory

      public OIDCLoginProtocolFactory()
  • Method Details

    • 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
    • create

      public org.keycloak.protocol.LoginProtocol create(org.keycloak.models.KeycloakSession session)
    • 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
    • addRolesClientScope

      public org.keycloak.models.ClientScopeModel addRolesClientScope(org.keycloak.models.RealmModel newRealm)
    • addWebOriginsClientScope

      public org.keycloak.models.ClientScopeModel addWebOriginsClientScope(org.keycloak.models.RealmModel newRealm)
    • addMicroprofileJWTClientScope

      public org.keycloak.models.ClientScopeModel addMicroprofileJWTClientScope(org.keycloak.models.RealmModel newRealm)
      Adds the microprofile-jwt optional client scope to the specified realm. If a microprofile-jwt client scope already exists in the realm then the existing scope is returned. Otherwise, a new scope is created and returned.
      Parameters:
      newRealm - the realm to which the microprofile-jwt scope is to be added.
      Returns:
      a reference to the microprofile-jwt client scope that was either created or already exists in the realm.
    • addAcrClientScope

      public org.keycloak.models.ClientScopeModel addAcrClientScope(org.keycloak.models.RealmModel newRealm)
    • addBasicClientScope

      public org.keycloak.models.ClientScopeModel addBasicClientScope(org.keycloak.models.RealmModel newRealm)
    • addServiceAccountClientScope

      public org.keycloak.models.ClientScopeModel addServiceAccountClientScope(org.keycloak.models.RealmModel newRealm)
    • addDefaults

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

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

      public String getId()
    • setupClientDefaults

      public void setupClientDefaults(org.keycloak.representations.idm.ClientRepresentation rep, org.keycloak.models.ClientModel newClient)
    • order

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

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