com.nimbusds.openid.connect.sdk.op

Class ACRRequest

java.lang.Object

com.nimbusds.openid.connect.sdk.op.ACRRequest

@Immutable
public final class ACRRequest
extends Object

Resolved authentication Context Class Reference (ACR) request.

Constructor Summary

Constructors

Constructor and Description
ACRRequest(List<ACR> essentialACRs, List<ACR> voluntaryACRs) Creates a new Authentication Context Class Reference (ACR) request.

Method Summary

Methods

Modifier and Type	Method and Description
List<ACR>	getEssentialACRs() Gets the requested essential ACR values.
List<ACR>	getVoluntaryACRs() Gets the requested voluntary ACR values.
boolean	isEmpty() Checks if this authentication Context Class Reference (ACR) request has not essential or voluntary values specified.
static ACRRequest	resolve(AuthenticationRequest authRequest) Resolves the requested essential and voluntary ACR values from the specified OpenID Connect authentication request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ACRRequest

public ACRRequest(List<ACR> essentialACRs,
          List<ACR> voluntaryACRs)

Creates a new Authentication Context Class Reference (ACR) request.

Parameters:

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.

Method Detail

getEssentialACRs

public List<ACR> getEssentialACRs()

Gets the requested essential ACR values.

Returns:

The essential ACR values, by order of preference, null if not specified.

getVoluntaryACRs

public List<ACR> getVoluntaryACRs()

Gets the requested voluntary ACR values.

Returns:

The voluntary ACR values, by order of preference, null if not specified.

isEmpty

public boolean isEmpty()

Checks if this authentication Context Class Reference (ACR) request has not essential or voluntary values specified.

Returns:

true if this ACR request doesn't specify any essential or voluntary values, else false.

resolve

public static ACRRequest resolve(AuthenticationRequest authRequest)

Resolves the requested essential and voluntary ACR values from the specified OpenID Connect authentication request.

Parameters:

authRequest - The OpenID Connect authentication request. Should be resolved. Must not be null.

Returns:

The resolved ACR request.