net.shibboleth.idp.attribute.consent

Enum ConsentContext.Consent

java.lang.Object

java.lang.Enum<ConsentContext.Consent>

net.shibboleth.idp.attribute.consent.ConsentContext.Consent

All Implemented Interfaces:

Serializable, Comparable<ConsentContext.Consent>

Enclosing class:

ConsentContext

public static enum ConsentContext.Consent
extends Enum<ConsentContext.Consent>

Indicates the result of the consent engine's attempt to gain user consent.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DENIED User denied the release of information.
INAPPLICABLE Indicates that it was not possible to determine the user's consent for the given request.
OBTAINED Consent engine prompted the user for consent and the user gave it.
PRIOR User gave direction in the past that the release of information, in this case, was acceptable.
UNSPECIFIED Indicates that no claim is made about the user's consent to the release of information.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNSPECIFIED

public static final ConsentContext.Consent UNSPECIFIED

Indicates that no claim is made about the user's consent to the release of information.

INAPPLICABLE

public static final ConsentContext.Consent INAPPLICABLE

Indicates that it was not possible to determine the user's consent for the given request. For example, the only approach for asking the user, supported by the engine implementation, is to display a web page but the protocol in use does not allow that.

OBTAINED

public static final ConsentContext.Consent OBTAINED

Consent engine prompted the user for consent and the user gave it.

PRIOR

public static final ConsentContext.Consent PRIOR

User gave direction in the past that the release of information, in this case, was acceptable. For example, by means of a "remember my decision" box on a web page.

DENIED

public static final ConsentContext.Consent DENIED

User denied the release of information.

Method Detail

values

public static ConsentContext.Consent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConsentContext.Consent c : ConsentContext.Consent.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConsentContext.Consent valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null