Package org.keycloak.protocol.oid4vc.issuance

Class OID4VCAuthorizationDetailsProcessor

java.lang.Object

org.keycloak.protocol.oid4vc.issuance.OID4VCAuthorizationDetailsProcessor

All Implemented Interfaces:

AuthorizationDetailsProcessor, Provider

public class OID4VCAuthorizationDetailsProcessor
extends Object
implements AuthorizationDetailsProcessor

Constructor Summary

Constructors

Constructor	Description
OID4VCAuthorizationDetailsProcessor(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	close()
List<AuthorizationDetailsResponse>	handleMissingAuthorizationDetails(UserSessionModel userSession, ClientSessionContext clientSessionCtx)	Method is invoked in cases when authorization_details parameter is missing in the request.
boolean	isSupported()	Checks if this processor should be regarded as supported in the running context.
List<AuthorizationDetailsResponse>	process(UserSessionModel userSession, ClientSessionContext clientSessionCtx, String authorizationDetailsParameter)	Processes the authorization_details parameter and returns a response if this processor is able to handle the given authorization_details parameter.
List<AuthorizationDetailsResponse>	processStoredAuthorizationDetails(UserSessionModel userSession, ClientSessionContext clientSessionCtx, String storedAuthDetails)	Method is invoked when authorization_details was used in the authorization request but is missing from the token request.

Methods inherited from class java.lang.Object

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

Constructor Details

OID4VCAuthorizationDetailsProcessor

public OID4VCAuthorizationDetailsProcessor(KeycloakSession session)

Method Details

isSupported

public boolean isSupported()

Description copied from interface: AuthorizationDetailsProcessor

Checks if this processor should be regarded as supported in the running context.

Specified by:

isSupported in interface AuthorizationDetailsProcessor

process

public List<AuthorizationDetailsResponse> process(UserSessionModel userSession,
 ClientSessionContext clientSessionCtx,
 String authorizationDetailsParameter)

Description copied from interface: AuthorizationDetailsProcessor

Processes the authorization_details parameter and returns a response if this processor is able to handle the given authorization_details parameter.

Specified by:

process in interface AuthorizationDetailsProcessor

Parameters:

userSession - the user session

clientSessionCtx - the client session context

authorizationDetailsParameter - the raw authorization_details parameter value

Returns:

authorization details response if this processor can handle the parameter, null if the parameter is incompatible with this processor

handleMissingAuthorizationDetails

public List<AuthorizationDetailsResponse> handleMissingAuthorizationDetails(UserSessionModel userSession,
 ClientSessionContext clientSessionCtx)

Description copied from interface: AuthorizationDetailsProcessor

Method is invoked in cases when authorization_details parameter is missing in the request. It allows processor to generate authorization details response in such a case

Specified by:

handleMissingAuthorizationDetails in interface AuthorizationDetailsProcessor

Parameters:

userSession - the user session

clientSessionCtx - the client session context

Returns:

authorization details response if this processor can handle current request in case that authorization_details parameter was not provided

processStoredAuthorizationDetails

public List<AuthorizationDetailsResponse> processStoredAuthorizationDetails(UserSessionModel userSession,
 ClientSessionContext clientSessionCtx,
 String storedAuthDetails)
                                                                     throws OAuthErrorException

Description copied from interface: AuthorizationDetailsProcessor

Method is invoked when authorization_details was used in the authorization request but is missing from the token request. This method should process the stored authorization_details and ensure they are returned in the token response.

Specified by:

processStoredAuthorizationDetails in interface AuthorizationDetailsProcessor

Parameters:

userSession - the user session

clientSessionCtx - the client session context

storedAuthDetails - the authorization_details that were stored during the authorization request

Returns:

authorization details response if this processor can handle the stored authorization_details, null if the processor cannot handle the stored authorization_details

Throws:

OAuthErrorException

close

public void close()

Specified by:

close in interface Provider