Package org.keycloak.protocol.oid4vc.issuance.requiredactions

Class VerifiableCredentialOfferAction

java.lang.Object

org.keycloak.protocol.oid4vc.issuance.requiredactions.VerifiableCredentialOfferAction

All Implemented Interfaces:

RequiredActionFactory, RequiredActionProvider, OID4VCEnvironmentProviderFactory, EnvironmentDependentProviderFactory, Provider, ProviderFactory<RequiredActionProvider>

public class VerifiableCredentialOfferAction
extends Object
implements RequiredActionProvider, RequiredActionFactory, OID4VCEnvironmentProviderFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VerifiableCredentialOfferAction.CredentialOfferActionConfig

Field Summary

Fields inherited from interface org.keycloak.authentication.RequiredActionFactory

MAX_AUTH_AGE_CONFIG_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
VerifiableCredentialOfferAction()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
RequiredActionProvider	create(KeycloakSession session)
void	evaluateTriggers(RequiredActionContext context)	Called every time a user authenticates.
String	getDisplayText()	Display text used in admin console to reference this required action
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
void	initiatedActionCanceled(KeycloakSession session, AuthenticationSessionModel authSession)	Callback to let the action know that an application-initiated action was canceled.
InitiatedActionSupport	initiatedActionSupport()	Determines what type of support is provided for application-initiated actions.
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
void	processAction(RequiredActionContext context)	Called when a required action has form input you want to process.
void	requiredActionChallenge(RequiredActionContext context)	If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser.

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, order

Methods inherited from interface org.keycloak.authentication.RequiredActionFactory

getConfigMetadata, isConfigurable, isOneTimeAction, validateConfig

Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

getMaxAuthAge, getMaxAuthAge

Constructor Details

VerifiableCredentialOfferAction

public VerifiableCredentialOfferAction()

Method Details

getDisplayText

public String getDisplayText()

Description copied from interface: RequiredActionFactory

Display text used in admin console to reference this required action

Specified by:

getDisplayText in interface RequiredActionFactory

Returns:

create

public RequiredActionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<RequiredActionProvider>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<RequiredActionProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<RequiredActionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<RequiredActionProvider>

evaluateTriggers

public void evaluateTriggers(RequiredActionContext context)

Description copied from interface: RequiredActionProvider

Called every time a user authenticates. This checks to see if this required action should be triggered. The implementation of this method is responsible for setting the required action on the UserModel. For example, the UpdatePassword required actions checks the password policies to see if the password has expired.

Specified by:

evaluateTriggers in interface RequiredActionProvider

requiredActionChallenge

public void requiredActionChallenge(RequiredActionContext context)

Description copied from interface: RequiredActionProvider

If the user has a required action set, this method will be the initial call to obtain what to display to the user's browser. Return null if no action should be done.

Specified by:

requiredActionChallenge in interface RequiredActionProvider

processAction

public void processAction(RequiredActionContext context)

Description copied from interface: RequiredActionProvider

Called when a required action has form input you want to process.

Specified by:

processAction in interface RequiredActionProvider

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<RequiredActionProvider>

initiatedActionSupport

public InitiatedActionSupport initiatedActionSupport()

Description copied from interface: RequiredActionProvider

Determines what type of support is provided for application-initiated actions.

Specified by:

initiatedActionSupport in interface RequiredActionProvider

Returns:

InititatedActionsSupport

initiatedActionCanceled

public void initiatedActionCanceled(KeycloakSession session,
 AuthenticationSessionModel authSession)

Description copied from interface: RequiredActionProvider

Callback to let the action know that an application-initiated action was canceled.

Specified by:

initiatedActionCanceled in interface RequiredActionProvider

Parameters:

session - The Keycloak session.

authSession - The authentication session.