@Immutable public final class ACRRequest extends Object
Constructor and Description |
---|
ACRRequest(List<ACR> essentialACRs,
List<ACR> voluntaryACRs)
Creates a new Authentication Context Class Reference (ACR) request.
|
Modifier and Type | Method and Description |
---|---|
ACRRequest |
applyDefaultACRs(OIDCClientInformation clientInfo)
Applies the registered default ACR values for the requesting client
(as a voluntary ACR value, provided no ACR values were explicitly
requested).
|
void |
ensureACRSupport(AuthenticationRequest authRequest,
OIDCProviderMetadata opMetadata)
Deprecated.
|
void |
ensureACRSupport(AuthorizationRequest authzRequest,
List<ACR> supportedACRs)
Ensures all requested essential ACR values are supported by those
supported by the OpenID provider.
|
List<ACR> |
getEssentialACRs()
Gets the requested essential ACR values.
|
List<ACR> |
getVoluntaryACRs()
Gets the requested voluntary ACR values.
|
boolean |
isEmpty()
Checks if this ACR request has no essential or voluntary values
specified.
|
static ACRRequest |
resolve(AuthorizationRequest authzRequest)
Resolves the requested essential and voluntary ACR values from the
specified OAuth 2.0 authorisation request / OpenID authentication
request.
|
public ACRRequest(List<ACR> essentialACRs, List<ACR> voluntaryACRs)
essentialACRs
- The requested essential ACR values, by order of
preference, null
if not specified.voluntaryACRs
- The requested voluntary ACR values, by order of
preference, null
if not specified.public List<ACR> getEssentialACRs()
null
if not specified.public List<ACR> getVoluntaryACRs()
null
if not specified.public boolean isEmpty()
true
if this ACR request doesn't specify any
essential or voluntary values, else false
.public ACRRequest applyDefaultACRs(OIDCClientInformation clientInfo)
clientInfo
- The registered client information. Must not be
null
.public void ensureACRSupport(AuthorizationRequest authzRequest, List<ACR> supportedACRs) throws GeneralException
authzRequest
- The OAuth 2.0 authorisation request / OpenID
authentication request. Must not be
null
.supportedACRs
- The ACR values supported by the OpenID
provider, null
if not specified.GeneralException
- If a requested essential ACR value is not
supported by the OpenID provider.@Deprecated public void ensureACRSupport(AuthenticationRequest authRequest, OIDCProviderMetadata opMetadata) throws GeneralException
authRequest
- The OpenID authentication request. Must not be
null
.opMetadata
- The OpenID provider metadata. Must not be
null
.GeneralException
- If a requested essential ACR value is not
supported by the OpenID provider.public static ACRRequest resolve(AuthorizationRequest authzRequest)
authzRequest
- The OAuth 2.0 authorisation request / OpenID
authentication request. Should be resolved. Must
not be null
.Copyright © 2018 Connect2id Ltd.. All rights reserved.