Package org.keycloak.protocol

Class AbstractLoginProtocolFactory

java.lang.Object

org.keycloak.protocol.AbstractLoginProtocolFactory

All Implemented Interfaces:

LoginProtocolFactory, ProviderFactory<LoginProtocol>

Direct Known Subclasses:

DockerAuthV2ProtocolFactory, OIDCLoginProtocolFactory, SamlProtocolFactory

public abstract class AbstractLoginProtocolFactory
extends Object
implements LoginProtocolFactory

Version:

$Revision: 1 $

Author:

Bill Burke

Constructor Summary

Constructors

Constructor	Description
AbstractLoginProtocolFactory()

Method Summary

Modifier and Type	Method	Description
void	addClientScopeDefaults(ClientScopeRepresentation clientModel)	Add default values to ClientScopeRepresentations that refer to the specific login-protocol
protected void	addDefaultClientScopes(RealmModel realm, Stream<ClientModel> newClients)
protected void	addDefaultClientScopes(RealmModel realm, ClientModel newClient)
protected abstract void	addDefaults(ClientModel clientModel)
void	close()	This is called when the server shuts down.
void	createDefaultClientScopes(RealmModel newRealm, boolean addScopesToExistingClients)	Called when new realm is created
protected abstract void	createDefaultClientScopesImpl(RealmModel newRealm)	Impl should create default client scopes.
void	init(Config.Scope config)	Only called once when the factory is first created.
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

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

createProtocolEndpoint, getBuiltinMappers, setupClientDefaults

Methods inherited from interface org.keycloak.provider.ProviderFactory

create, dependsOn, getConfigMetadata, getId, order

Constructor Details

AbstractLoginProtocolFactory

public AbstractLoginProtocolFactory()

Method Details

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<LoginProtocol>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<LoginProtocol>

createDefaultClientScopes

public void createDefaultClientScopes(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(RealmModel newRealm)

Impl should create default client scopes. This is called usually when new realm is created

addDefaultClientScopes

protected void addDefaultClientScopes(RealmModel realm,
 ClientModel newClient)

addDefaultClientScopes

protected void addDefaultClientScopes(RealmModel realm,
 Stream<ClientModel> newClients)

addDefaults

protected abstract void addDefaults(ClientModel clientModel)

addClientScopeDefaults

public void addClientScopeDefaults(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()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<LoginProtocol>