Package org.keycloak.keys

Class AbstractGeneratedRsaKeyProviderFactory

java.lang.Object

org.keycloak.keys.AbstractRsaKeyProviderFactory

org.keycloak.keys.AbstractGeneratedRsaKeyProviderFactory

All Implemented Interfaces:

ComponentFactory, KeyProviderFactory, ConfiguredProvider, ProviderFactory

Direct Known Subclasses:

GeneratedRsaEncKeyProviderFactory, GeneratedRsaKeyProviderFactory

public abstract class AbstractGeneratedRsaKeyProviderFactory
extends AbstractRsaKeyProviderFactory

Constructor Summary

Constructors

Constructor	Description
AbstractGeneratedRsaKeyProviderFactory()

Method Summary

Modifier and Type	Method	Description
boolean	createFallbackKeys(KeycloakSession session, KeyUse keyUse, String algorithm)
protected ProviderConfigurationBuilder	generatedRsaKeyConfigurationBuilder()
protected abstract org.jboss.logging.Logger	getLogger()
void	init(Config.Scope config)	Only called once when the factory is first created.
protected abstract boolean	isSupportedRsaAlgorithm(String algorithm)
protected abstract boolean	isValidKeyUse(KeyUse keyUse)
static final ProviderConfigurationBuilder	rsaKeyConfigurationBuilder()
void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model)	Called before a component is created or updated.

Methods inherited from class org.keycloak.keys.AbstractRsaKeyProviderFactory

configurationBuilder

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, onCreate, onUpdate, preRemove

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.keys.KeyProviderFactory

close, create, postInit

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, getId, order

Constructor Details

AbstractGeneratedRsaKeyProviderFactory

public AbstractGeneratedRsaKeyProviderFactory()

Method Details

getLogger

protected abstract org.jboss.logging.Logger getLogger()

rsaKeyConfigurationBuilder

public static final ProviderConfigurationBuilder rsaKeyConfigurationBuilder()

generatedRsaKeyConfigurationBuilder

protected ProviderConfigurationBuilder generatedRsaKeyConfigurationBuilder()

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

createFallbackKeys

public boolean createFallbackKeys(KeycloakSession session,
 KeyUse keyUse,
 String algorithm)

isValidKeyUse

protected abstract boolean isValidKeyUse(KeyUse keyUse)

isSupportedRsaAlgorithm

protected abstract boolean isSupportedRsaAlgorithm(String algorithm)

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

Overrides:

validateConfiguration in class AbstractRsaKeyProviderFactory

Throws:

ComponentValidationException