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()
static ProviderConfigurationBuilder	configurationBuilder()
default void	init(Config.Scope config)
default boolean	isSupported()
default boolean	isSupported(Config.Scope config)
default void	postInit(KeycloakSessionFactory factory)
Format	supportedFormat()	Should return the credentials format supported by the signing service.
default void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model)
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

Specified by:

validateConfiguration in interface ComponentFactory<VerifiableCredentialsSigningService,VerifiableCredentialsSigningService>

Throws:

ComponentValidationException

close

default void close()

Specified by:

close in interface ProviderFactory<VerifiableCredentialsSigningService>

init

default void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<VerifiableCredentialsSigningService>

postInit

default void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<VerifiableCredentialsSigningService>

isSupported

default boolean isSupported(Config.Scope config)

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

isSupported

default boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

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