Package org.keycloak.protocol.oauth2

Class OAuth2WellKnownProviderFactory

java.lang.Object

org.keycloak.protocol.oidc.OIDCWellKnownProviderFactory

org.keycloak.protocol.oauth2.OAuth2WellKnownProviderFactory

All Implemented Interfaces:

org.keycloak.provider.ProviderFactory<WellKnownProvider>, WellKnownProviderFactory

public class OAuth2WellKnownProviderFactory
extends OIDCWellKnownProviderFactory

OAuth2WellKnownProviderFactory implementation for the OAuth2 auto discovery

Author:

Francis Pouatcha

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
OAuth2WellKnownProviderFactory()

Method Summary

Modifier and Type	Method	Description
String	getId()
boolean	isAvailableViaServerMetadata()	Controls if the WellKnownProvider is available via server metadata endpoint.

Methods inherited from class org.keycloak.protocol.oidc.OIDCWellKnownProviderFactory

close, create, getConfigMetadata, getOpenidConfigOverride, getPriority, init, initConfigOverrideFromFile, 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.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

OAuth2WellKnownProviderFactory

public OAuth2WellKnownProviderFactory()

Method Details

getId

public String getId()

Specified by:

getId in interface org.keycloak.provider.ProviderFactory<WellKnownProvider>

Overrides:

getId in class OIDCWellKnownProviderFactory

isAvailableViaServerMetadata

public boolean isAvailableViaServerMetadata()

Description copied from interface: WellKnownProviderFactory

Controls if the WellKnownProvider is available via server metadata endpoint. If this method returns true, then the provider will be available under /.well-known/{alias}/realms/{realm}, where {alias} is the well-known alias returned by WellKnownProviderFactory.getAlias(). Default implementation returns false.

Returns:

true if this provider may be exposed via ServerMetadataResource