Package org.keycloak.protocol.oid4vc.issuance.signing

Interface VCSigningServiceProviderFactory

All Superinterfaces:

ComponentFactory<VerifiableCredentialsSigningService,VerifiableCredentialsSigningService>, ConfiguredProvider, EnvironmentDependentProviderFactory, ProviderFactory<VerifiableCredentialsSigningService>

All Known Implementing Classes:

JwtSigningServiceProviderFactory, LDSigningServiceProviderFactory, SdJwtSigningServiceProviderFactory

public interface VCSigningServiceProviderFactory
extends ComponentFactory<VerifiableCredentialsSigningService,VerifiableCredentialsSigningService>, EnvironmentDependentProviderFactory

Provider Factory to create VerifiableCredentialsSigningServices

Author:

Stefan Wiedemann

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ISSUER_DID_REALM_ATTRIBUTE_KEY	Key for the realm attribute providing the issuerDidy.

Method Summary

Modifier and Type	Method	Description
default void	close()	This is called when the server shuts down.
static ProviderConfigurationBuilder	configurationBuilder()
default void	init(Config.Scope config)	Only called once when the factory is first created.
default boolean	isSupported()
default boolean	isSupported(Config.Scope config)	An alternative to EnvironmentDependentProviderFactory.isSupported() method to check if the provider is supported based on the provider configuration.
default void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
Format	supportedFormat()	Should return the credentials format supported by the signing service.
default void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model)	Called before a component is created or updated.
void	validateSpecificConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model)	Should validate potential implementation specific configuration of the factory.

Methods inherited from interface org.keycloak.component.ComponentFactory

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

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, getId, order

Field Details

ISSUER_DID_REALM_ATTRIBUTE_KEY

static final String ISSUER_DID_REALM_ATTRIBUTE_KEY

Key for the realm attribute providing the issuerDidy.

See Also:

• Constant Field Values

Method Details

configurationBuilder

static ProviderConfigurationBuilder configurationBuilder()

validateConfiguration

default 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<VerifiableCredentialsSigningService,VerifiableCredentialsSigningService>

Throws:

ComponentValidationException

close

default void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<VerifiableCredentialsSigningService>

init

default 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

Specified by:

init in interface ProviderFactory<VerifiableCredentialsSigningService>

postInit

default void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<VerifiableCredentialsSigningService>

isSupported

default boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

An alternative to EnvironmentDependentProviderFactory.isSupported() method to check if the provider is supported 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.

isSupported

default boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Returns:

true if the provider is supported and should be available, false otherwise

validateSpecificConfiguration

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

Should validate potential implementation specific configuration of the factory.

Throws:

ComponentValidationException

supportedFormat

Format supportedFormat()

Should return the credentials format supported by the signing service.

Returns:

the format