Package org.keycloak.protocol.oid4vc.issuance.credentialbuilder

Interface CredentialBuilder

All Superinterfaces:

Provider

All Known Implementing Classes:

JwtCredentialBuilder, LDCredentialBuilder, SdJwtCredentialBuilder

public interface CredentialBuilder
extends Provider

Method Summary

Modifier and Type	Method	Description
CredentialBody	buildCredentialBody(VerifiableCredential verifiableCredential, CredentialBuildConfig credentialBuildConfig)	Builds a verifiable credential of a specific format from the basis of an internal representation of the credential.
default void	close()
String	getSupportedFormat()	Returns the credential format supported by the builder.

Method Details

close

default void close()

Specified by:

close in interface Provider

getSupportedFormat

String getSupportedFormat()

Returns the credential format supported by the builder.

buildCredentialBody

CredentialBody buildCredentialBody(VerifiableCredential verifiableCredential,
 CredentialBuildConfig credentialBuildConfig)
                            throws CredentialBuilderException

Builds a verifiable credential of a specific format from the basis of an internal representation of the credential.

The credential is built incompletely, intended that it would be signed externally.

Parameters:

verifiableCredential - an internal representation of the credential

credentialBuildConfig - additional configurations for building the credential

Returns:

the built verifiable credential of the specific format, ready to be signed

Throws:

CredentialBuilderException