Interface VCSigningServiceProviderFactory
- All Superinterfaces:
ComponentFactory<VerifiableCredentialsSigningService,
,VerifiableCredentialsSigningService> ConfiguredProvider
,EnvironmentDependentProviderFactory
,OID4VCEnvironmentProviderFactory
,ProviderFactory<VerifiableCredentialsSigningService>
- All Known Implementing Classes:
JwtSigningServiceProviderFactory
,LDSigningServiceProviderFactory
,SdJwtSigningServiceProviderFactory
public interface VCSigningServiceProviderFactory
extends ComponentFactory<VerifiableCredentialsSigningService,VerifiableCredentialsSigningService>, OID4VCEnvironmentProviderFactory
Provider Factory to create
VerifiableCredentialsSigningService
s- Author:
- Stefan Wiedemann
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Key for the realm attribute providing the issuerDidy. -
Method Summary
Modifier and TypeMethodDescriptiondefault void
close()
This is called when the server shuts down.static ProviderConfigurationBuilder
default void
init
(Config.Scope config) Only called once when the factory is first created.default boolean
isSupported
(Config.Scope config) Check if the provider is supported and should be available based on the provider configuration.default void
postInit
(KeycloakSessionFactory factory) Called after all provider factories have been initializedShould 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
Key for the realm attribute providing the issuerDidy.- See Also:
-
-
Method Details
-
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 interfaceComponentFactory<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 interfaceProviderFactory<VerifiableCredentialsSigningService>
-
init
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 interfaceProviderFactory<VerifiableCredentialsSigningService>
-
postInit
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<VerifiableCredentialsSigningService>
-
isSupported
Description copied from interface:EnvironmentDependentProviderFactory
Check if the provider is supported and should be available based on the provider configuration.- Specified by:
isSupported
in interfaceEnvironmentDependentProviderFactory
- Specified by:
isSupported
in interfaceOID4VCEnvironmentProviderFactory
- Parameters:
config
- the provider configuration- Returns:
true
if the provider is supported. Otherwise,false
.
-
validateSpecificConfiguration
void validateSpecificConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) throws ComponentValidationException Should validate potential implementation specific configuration of the factory.- Throws:
ComponentValidationException
-
supportedFormat
String supportedFormat()Should return the credentials format supported by the signing service.- Returns:
- the format
-