Package org.keycloak.broker.oauth

Class OAuth2IdentityProviderFactory

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProviderFactory<OAuth2IdentityProvider>

org.keycloak.broker.oauth.OAuth2IdentityProviderFactory

All Implemented Interfaces:

IdentityProviderFactory<OAuth2IdentityProvider>, ConfiguredProvider, ProviderFactory<OAuth2IdentityProvider>

public class OAuth2IdentityProviderFactory
extends AbstractIdentityProviderFactory<OAuth2IdentityProvider>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
OAuth2IdentityProviderFactory()

Method Summary

Modifier and Type	Method	Description
OAuth2IdentityProvider	create(KeycloakSession session, IdentityProviderModel model)	Creates an IdentityProvider based on the configuration contained in model.
IdentityProviderModel	createConfig()	Creates a provider specific IdentityProviderModel instance.
String	getId()
String	getName()	A friendly name for this factory.
Map<String,String>	parseConfig(KeycloakSession session, String rawConfig)	Creates an IdentityProvider based on the configuration from inputStream.

Methods inherited from class org.keycloak.broker.provider.AbstractIdentityProviderFactory

close, create, init, 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.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.broker.provider.IdentityProviderFactory

getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

OAuth2IdentityProviderFactory

public OAuth2IdentityProviderFactory()

Method Details

getId

public String getId()

getName

public String getName()

Description copied from interface: IdentityProviderFactory

A friendly name for this factory.

Returns:

create

public OAuth2IdentityProvider create(KeycloakSession session,
 IdentityProviderModel model)

Description copied from interface: IdentityProviderFactory

Creates an IdentityProvider based on the configuration contained in model.

model - The configuration to be used to create the identity provider.

Returns:

createConfig

public IdentityProviderModel createConfig()

Description copied from interface: IdentityProviderFactory

Creates a provider specific IdentityProviderModel instance.

Providers may want to implement their own IdentityProviderModel type so that validations can be performed when managing the provider configuration

Returns:

the provider specific instance

parseConfig

public Map<String,String> parseConfig(KeycloakSession session,
 String rawConfig)

Description copied from interface: IdentityProviderFactory

Creates an IdentityProvider based on the configuration from inputStream.

Specified by:

parseConfig in interface IdentityProviderFactory<OAuth2IdentityProvider>

Overrides:

parseConfig in class AbstractIdentityProviderFactory<OAuth2IdentityProvider>

rawConfig - The configuration for the provider

Returns: