Package se.swedenconnect.opensaml.saml2.request

Enum Class AuthnRequestGeneratorContext.HokRequirement

java.lang.Object

java.lang.Enum<AuthnRequestGeneratorContext.HokRequirement>

se.swedenconnect.opensaml.saml2.request.AuthnRequestGeneratorContext.HokRequirement

All Implemented Interfaces:

Serializable, Comparable<AuthnRequestGeneratorContext.HokRequirement>, Constable

Enclosing interface:

AuthnRequestGeneratorContext

public static enum AuthnRequestGeneratorContext.HokRequirement
extends Enum<AuthnRequestGeneratorContext.HokRequirement>

Enumeration that tells whether the Holder-of-key WebSSO profile is required, optional or not active.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DONT_USE	The holder-of-key profile will never be used.
IF_AVAILABLE	The Holder-of-key profile will be used if the IdP supports it.
REQUIRED	The SP will always use HoK - A call to AuthnRequestGenerator.generateAuthnRequest(String, String, AuthnRequestGeneratorContext) for an IdP that does not support this profile will fail.

Method Summary

Modifier and Type	Method	Description
static AuthnRequestGeneratorContext.HokRequirement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AuthnRequestGeneratorContext.HokRequirement[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUIRED

public static final AuthnRequestGeneratorContext.HokRequirement REQUIRED

The SP will always use HoK - A call to AuthnRequestGenerator.generateAuthnRequest(String, String, AuthnRequestGeneratorContext) for an IdP that does not support this profile will fail.

IF_AVAILABLE

public static final AuthnRequestGeneratorContext.HokRequirement IF_AVAILABLE

The Holder-of-key profile will be used if the IdP supports it.

DONT_USE

public static final AuthnRequestGeneratorContext.HokRequirement DONT_USE

The holder-of-key profile will never be used.

Method Details

values

public static AuthnRequestGeneratorContext.HokRequirement[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AuthnRequestGeneratorContext.HokRequirement valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null