Package org.keycloak.protocol

Class AbstractLoginProtocolFactory

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

  • Constructor Details

    • AbstractLoginProtocolFactory

      public AbstractLoginProtocolFactory()

  • Method Details

    • init

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

    • postInit

      public void postInit(org.keycloak.models.KeycloakSessionFactory factory)
      Specified by:
      postInit in interface org.keycloak.provider.ProviderFactory<LoginProtocol>

    • createDefaultClientScopes

      public void createDefaultClientScopes(org.keycloak.models.RealmModel newRealm, boolean addScopesToExistingClients)
      Description copied from interface: LoginProtocolFactory
      Called when new realm is created
      Specified by:
      createDefaultClientScopes in interface LoginProtocolFactory
      addScopesToExistingClients - If true, then existing realm clients will be updated (created realm default scopes will be added to them)

    • createDefaultClientScopesImpl

      protected abstract void createDefaultClientScopesImpl(org.keycloak.models.RealmModel newRealm)
      Impl should create default client scopes. This is called usually when new realm is created

    • addDefaultClientScopes

      protected void addDefaultClientScopes(org.keycloak.models.RealmModel realm, org.keycloak.models.ClientModel newClient)

    • addDefaultClientScopes

      protected void addDefaultClientScopes(org.keycloak.models.RealmModel realm, Stream<org.keycloak.models.ClientModel> newClients)

    • addDefaults

      protected abstract void addDefaults(org.keycloak.models.ClientModel clientModel)

    • addClientScopeDefaults

      public void addClientScopeDefaults(org.keycloak.representations.idm.ClientScopeRepresentation clientModel)
      Description copied from interface: LoginProtocolFactory
      Add default values to ClientScopeRepresentations that refer to the specific login-protocol
      Specified by:
      addClientScopeDefaults in interface LoginProtocolFactory

    • close

      public void close()
      Specified by:
      close in interface org.keycloak.provider.ProviderFactory<LoginProtocol>