Package org.keycloak.protocol.oid4vc.issuance.mappers

Class OID4VCContextMapper

java.lang.Object

org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCContextMapper

All Implemented Interfaces:

OID4VCEnvironmentProviderFactory, ProtocolMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

public class OID4VCContextMapper
extends OID4VCMapper

Allows to add the context to the credential subject

Author:

Stefan Wiedemann

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAPPER_ID
static final String	TYPE_KEY

Fields inherited from class org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

CLAIM_NAME, format, mapperModel, USER_ATTRIBUTE_KEY

Constructor Summary

Constructors

Constructor	Description
OID4VCContextMapper()

Method Summary

Modifier and Type	Method	Description
ProtocolMapper	create(KeycloakSession session)
String	getDisplayType()
String	getHelpText()
String	getId()
protected List<ProviderConfigProperty>	getIndividualConfigProperties()
List<String>	getMetadataAttributePath()	must return ordered list of attribute-names as they are added into the credential.
boolean	includeInMetadata()	this claim is not added by default to the metadata
void	setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)	Set the claims to credential, like f.e.
void	setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)	Set the claims to the credential subject.

Methods inherited from class org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

close, getAttributePrefix, getConfigProperties, getDisplayCategory, getProtocol, init, postInit, setMapperModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.protocol.oid4vc.OID4VCEnvironmentProviderFactory

isSupported

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getEffectiveModel, getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

MAPPER_ID

public static final String MAPPER_ID

See Also:

• Constant Field Values

TYPE_KEY

public static final String TYPE_KEY

See Also:

• Constant Field Values

Constructor Details

OID4VCContextMapper

public OID4VCContextMapper()

Method Details

getIndividualConfigProperties

protected List<ProviderConfigProperty> getIndividualConfigProperties()

Specified by:

getIndividualConfigProperties in class OID4VCMapper

includeInMetadata

public boolean includeInMetadata()

this claim is not added by default to the metadata

Overrides:

includeInMetadata in class OID4VCMapper

getMetadataAttributePath

public List<String> getMetadataAttributePath()

Description copied from class: OID4VCMapper

must return ordered list of attribute-names as they are added into the credential. This is required for the metadata endpoint to add the appropriate path-attributes into the claim's description.

Overrides:

getMetadataAttributePath in class OID4VCMapper

Returns:

the attribute path that is being mapped into the credential

setClaimsForCredential

public void setClaimsForCredential(VerifiableCredential verifiableCredential,
 UserSessionModel userSessionModel)

Description copied from class: OID4VCMapper

Set the claims to credential, like f.e. the context

Specified by:

setClaimsForCredential in class OID4VCMapper

setClaimsForSubject

public void setClaimsForSubject(Map<String,Object> claims,
 UserSessionModel userSessionModel)

Description copied from class: OID4VCMapper

Set the claims to the credential subject.

Specified by:

setClaimsForSubject in class OID4VCMapper

getDisplayType

public String getDisplayType()

getHelpText

public String getHelpText()

create

public ProtocolMapper create(KeycloakSession session)

getId

public String getId()