Package com.pingidentity.sdk.authorizationdetails

Class AuthorizationDetailContext

java.lang.Object

com.pingidentity.sdk.authorizationdetails.AuthorizationDetailContext

public class AuthorizationDetailContext
extends Object

A wrapper class for contextual information used by AuthorizationDetailProcessor methods.

Since:

11.2

Constructor Summary

Constructors

Constructor	Description
AuthorizationDetailContext(javax.servlet.http.HttpServletRequest request, String clientId, Scope scope)	The constructor for the authorization details contextual information.

Method Summary

Modifier and Type	Method	Description
String	getClientId()	Get the client Id.
javax.servlet.http.HttpServletRequest	getRequest()	Get the HttpServletRequest.
Set<String>	getScope()	Gets the scope of access requested.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationDetailContext

public AuthorizationDetailContext(javax.servlet.http.HttpServletRequest request,
                                  String clientId,
                                  Scope scope)

The constructor for the authorization details contextual information.

Parameters:

request - The HttpServletRequest.

clientId - The client id.

scope - The scope set

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Get the HttpServletRequest.

Returns:

HttpServletRequest, or null.

getClientId

public String getClientId()

Get the client Id.

Returns:

the client id, or null.

getScope

public Set<String> getScope()

Gets the scope of access requested. These scopes are requested scopes when this context is provided during AuthorizationDetailProcessor.validate(com.pingidentity.sdk.authorizationdetails.AuthorizationDetail, com.pingidentity.sdk.authorizationdetails.AuthorizationDetailContext, java.util.Map<java.lang.String, java.lang.Object>), AuthorizationDetailProcessor.getUserConsentDescription(com.pingidentity.sdk.authorizationdetails.AuthorizationDetail, com.pingidentity.sdk.authorizationdetails.AuthorizationDetailContext, java.util.Map<java.lang.String, java.lang.Object>) and AuthorizationDetailProcessor.enrich(com.pingidentity.sdk.authorizationdetails.AuthorizationDetail, com.pingidentity.sdk.authorizationdetails.AuthorizationDetailContext, java.util.Map<java.lang.String, java.lang.Object>). Approved scopes are provided for AuthorizationDetailProcessor.isEqualOrSubset(com.pingidentity.sdk.authorizationdetails.AuthorizationDetail, com.pingidentity.sdk.authorizationdetails.AuthorizationDetail, com.pingidentity.sdk.authorizationdetails.AuthorizationDetailContext, java.util.Map<java.lang.String, java.lang.Object>)

Returns:

A set with the scope, or null.