Package org.keycloak.protocol.oid4vc

Class OID4VCLoginProtocolFactory

java.lang.Object

org.keycloak.protocol.oid4vc.OID4VCLoginProtocolFactory

All Implemented Interfaces:

LoginProtocolFactory, OID4VCEnvironmentProviderFactory, EnvironmentDependentProviderFactory, ProviderFactory<LoginProtocol>

public class OID4VCLoginProtocolFactory
extends Object
implements LoginProtocolFactory, OID4VCEnvironmentProviderFactory

Factory for creating all OID4VC related endpoints and the default mappers.

Author:

Stefan Wiedemann

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROTOCOL_ID

Constructor Summary

Constructors

Constructor	Description
OID4VCLoginProtocolFactory()

Method Summary

Modifier and Type	Method	Description
void	close()
LoginProtocol	create(KeycloakSession session)
void	createDefaultClientScopes(RealmModel newRealm, boolean addScopesToExistingClients)
Object	createProtocolEndpoint(KeycloakSession keycloakSession, EventBuilder event)
Map<String,ProtocolMapperModel>	getBuiltinMappers()
String	getId()
void	init(Config.Scope config)
int	order()	defines the option-order in the admin-ui
void	postInit(KeycloakSessionFactory factory)
void	setupClientDefaults(ClientRepresentation rep, ClientModel newClient)

Methods inherited from class java.lang.Object

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

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

isSupported

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata

Field Details

PROTOCOL_ID

public static final String PROTOCOL_ID

See Also:

• Constant Field Values

Constructor Details

OID4VCLoginProtocolFactory

public OID4VCLoginProtocolFactory()

Method Details

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<LoginProtocol>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<LoginProtocol>

close

public void close()

Specified by:

close in interface ProviderFactory<LoginProtocol>

getBuiltinMappers

public Map<String,ProtocolMapperModel> getBuiltinMappers()

Specified by:

getBuiltinMappers in interface LoginProtocolFactory

createProtocolEndpoint

public Object createProtocolEndpoint(KeycloakSession keycloakSession,
 EventBuilder event)

Specified by:

createProtocolEndpoint in interface LoginProtocolFactory

createDefaultClientScopes

public void createDefaultClientScopes(RealmModel newRealm,
 boolean addScopesToExistingClients)

Specified by:

createDefaultClientScopes in interface LoginProtocolFactory

setupClientDefaults

public void setupClientDefaults(ClientRepresentation rep,
 ClientModel newClient)

Specified by:

setupClientDefaults in interface LoginProtocolFactory

create

public LoginProtocol create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<LoginProtocol>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<LoginProtocol>

order

public int order()

defines the option-order in the admin-ui

Specified by:

order in interface ProviderFactory<LoginProtocol>