Package org.keycloak.keys

Class JavaKeystoreKeyProviderFactory

java.lang.Object

org.keycloak.keys.JavaKeystoreKeyProviderFactory

All Implemented Interfaces:

ComponentFactory, KeyProviderFactory, ConfiguredProvider, ProviderFactory

public class JavaKeystoreKeyProviderFactory
extends Object
implements KeyProviderFactory

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID
static final String	KEY_ALIAS_KEY
static final ProviderConfigProperty	KEY_ALIAS_PROPERTY
static final String	KEY_PASSWORD_KEY
static final ProviderConfigProperty	KEY_PASSWORD_PROPERTY
static final String	KEYSTORE_KEY
static final String	KEYSTORE_PASSWORD_KEY
static final ProviderConfigProperty	KEYSTORE_PASSWORD_PROPERTY
static final ProviderConfigProperty	KEYSTORE_PROPERTY
static final String	KEYSTORE_TYPE_KEY
static final String	KEYSTORES_PATH_INIT_KEY

Constructor Summary

Constructors

Constructor	Description
JavaKeystoreKeyProviderFactory()

Method Summary

Modifier and Type	Method	Description
KeyProvider	create(KeycloakSession session, ComponentModel model)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
List<ProviderConfigProperty>	getConfigProperties()
String	getHelpText()
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model)	Called before a component is created or updated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.component.ComponentFactory

create, getCommonProviderConfigProperties, getTypeMetadata, isInternal, onCreate, onUpdate, preRemove

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.keys.KeyProviderFactory

close, createFallbackKeys, postInit

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, order

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

KEYSTORES_PATH_INIT_KEY

public static final String KEYSTORES_PATH_INIT_KEY

See Also:

• Constant Field Values

KEYSTORE_KEY

public static final String KEYSTORE_KEY

See Also:

• Constant Field Values

KEYSTORE_PROPERTY

public static final ProviderConfigProperty KEYSTORE_PROPERTY

KEYSTORE_PASSWORD_KEY

public static final String KEYSTORE_PASSWORD_KEY

See Also:

• Constant Field Values

KEYSTORE_PASSWORD_PROPERTY

public static final ProviderConfigProperty KEYSTORE_PASSWORD_PROPERTY

KEYSTORE_TYPE_KEY

public static final String KEYSTORE_TYPE_KEY

See Also:

• Constant Field Values

KEY_ALIAS_KEY

public static final String KEY_ALIAS_KEY

See Also:

• Constant Field Values

KEY_ALIAS_PROPERTY

public static final ProviderConfigProperty KEY_ALIAS_PROPERTY

KEY_PASSWORD_KEY

public static final String KEY_PASSWORD_KEY

See Also:

• Constant Field Values

KEY_PASSWORD_PROPERTY

public static final ProviderConfigProperty KEY_PASSWORD_PROPERTY

Constructor Details

JavaKeystoreKeyProviderFactory

public JavaKeystoreKeyProviderFactory()

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 KeyProviderFactory

Specified by:

init in interface ProviderFactory

create

public KeyProvider create(KeycloakSession session,
 ComponentModel model)

Specified by:

create in interface ComponentFactory

Specified by:

create in interface KeyProviderFactory

validateConfiguration

public void validateConfiguration(KeycloakSession session,
 RealmModel realm,
 ComponentModel model)
                           throws ComponentValidationException

Description copied from interface: ComponentFactory

Called before a component is created or updated. Allows you to validate the configuration

Specified by:

validateConfiguration in interface ComponentFactory

Throws:

ComponentValidationException

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface ProviderFactory

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

Returns:

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