Package org.keycloak.broker.kubernetes

Class KubernetesIdentityProviderFactory

java.lang.Object

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

org.keycloak.broker.kubernetes.KubernetesIdentityProviderFactory

All Implemented Interfaces:

IdentityProviderFactory<KubernetesIdentityProvider>, ConfiguredProvider, EnvironmentDependentProviderFactory, ProviderFactory<KubernetesIdentityProvider>

public class KubernetesIdentityProviderFactory
extends AbstractIdentityProviderFactory<KubernetesIdentityProvider>
implements EnvironmentDependentProviderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
KubernetesIdentityProviderFactory()

Method Summary

Modifier and Type	Method	Description
KubernetesIdentityProvider	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.
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
Map<String,String>	parseConfig(KeycloakSession session, String configString)	Creates an IdentityProvider based on the configuration from inputStream.

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

close, create, 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

KubernetesIdentityProviderFactory

public KubernetesIdentityProviderFactory()

Method Details

getName

public String getName()

Description copied from interface: IdentityProviderFactory

A friendly name for this factory.

Specified by:

getName in interface IdentityProviderFactory<KubernetesIdentityProvider>

Returns:

create

public KubernetesIdentityProvider create(KeycloakSession session,
 IdentityProviderModel model)

Description copied from interface: IdentityProviderFactory

Creates an IdentityProvider based on the configuration contained in model.

Specified by:

create in interface IdentityProviderFactory<KubernetesIdentityProvider>

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

Returns:

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

Overrides:

init in class AbstractIdentityProviderFactory<KubernetesIdentityProvider>

parseConfig

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

Description copied from interface: IdentityProviderFactory

Creates an IdentityProvider based on the configuration from inputStream.

Specified by:

parseConfig in interface IdentityProviderFactory<KubernetesIdentityProvider>

Overrides:

parseConfig in class AbstractIdentityProviderFactory<KubernetesIdentityProvider>

configString - The configuration for the 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

Specified by:

createConfig in interface IdentityProviderFactory<KubernetesIdentityProvider>

Returns:

the provider specific instance

getId

public String getId()

Specified by:

getId in interface ProviderFactory<KubernetesIdentityProvider>

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.