Package org.keycloak.protocol.oidc

Class OIDCWellKnownProviderFactory

java.lang.Object

org.keycloak.protocol.oidc.OIDCWellKnownProviderFactory

All Implemented Interfaces:

ProviderFactory<WellKnownProvider>, WellKnownProviderFactory

Direct Known Subclasses:

OAuth2WellKnownProviderFactory

public class OIDCWellKnownProviderFactory
extends Object
implements WellKnownProviderFactory

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
OIDCWellKnownProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
WellKnownProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
String	getId()
protected Map<String,Object>	getOpenidConfigOverride()
int	getPriority()	Use low priority, so custom implementation with alias "openid-configuration" will win over the default implementation with alias "openid-configuration", which is provided by Keycloak (OIDCWellKnownProviderFactory).
void	init(Config.Scope config)	Only called once when the factory is first created.
protected void	initConfigOverrideFromFile(String openidConfigurationOverrideFile)
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.provider.ProviderFactory

dependsOn, order

Methods inherited from interface org.keycloak.wellknown.WellKnownProviderFactory

getAlias

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

OIDCWellKnownProviderFactory

public OIDCWellKnownProviderFactory()

Method Details

create

public WellKnownProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<WellKnownProvider>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<WellKnownProvider>

initConfigOverrideFromFile

protected void initConfigOverrideFromFile(String openidConfigurationOverrideFile)

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<WellKnownProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<WellKnownProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<WellKnownProvider>

getPriority

public int getPriority()

Description copied from interface: WellKnownProviderFactory

Use low priority, so custom implementation with alias "openid-configuration" will win over the default implementation with alias "openid-configuration", which is provided by Keycloak (OIDCWellKnownProviderFactory).

Specified by:

getPriority in interface WellKnownProviderFactory

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<WellKnownProvider>

Returns:

a list with the metadata for each configuration property supported by this factory

getOpenidConfigOverride

protected Map<String,Object> getOpenidConfigOverride()