Module jakarta.security

Package jakarta.security.enterprise.authentication.mechanism.http.openid

Enum Class DisplayType

java.lang.Object

java.lang.Enum<DisplayType>

jakarta.security.enterprise.authentication.mechanism.http.openid.DisplayType

All Implemented Interfaces:

Serializable, Comparable<DisplayType>, Constable

public enum DisplayType
extends Enum<DisplayType>

Display specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.

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
PAGE	The Authorization Server should display authentication and consent UI consistent with a full User-Agent page view.
POPUP	The Authorization Server should display authentication and consent UI consistent with a popup User-Agent window.
TOUCH	The Authorization Server should display authentication and consent UI consistent with a device that leverages a touch interface.
WAP	The Authorization Server should display authentication and consent UI consistent with a "feature phone" type display.

Method Summary

Modifier and Type	Method	Description
static DisplayType	fromString(String key)
static DisplayType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DisplayType[]	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

PAGE

public static final DisplayType PAGE

The Authorization Server should display authentication and consent UI consistent with a full User-Agent page view. If the display parameter is not specified this is the default display mode.

POPUP

public static final DisplayType POPUP

The Authorization Server should display authentication and consent UI consistent with a popup User-Agent window.

TOUCH

public static final DisplayType TOUCH

The Authorization Server should display authentication and consent UI consistent with a device that leverages a touch interface.

WAP

public static final DisplayType WAP

The Authorization Server should display authentication and consent UI consistent with a "feature phone" type display.

Method Details

values

public static DisplayType[] 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 DisplayType 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

fromString

public static DisplayType fromString(String key)