fish.payara.security.openid.api

Enum DisplayType

java.lang.Object

java.lang.Enum<DisplayType>

fish.payara.security.openid.api.DisplayType

All Implemented Interfaces:

Serializable, Comparable<DisplayType>

public enum DisplayType
extends Enum<DisplayType>

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

Author:

Gaurav Gupta

Enum Constant Summary

Enum Constants

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

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 Detail

values

public static DisplayType[] 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 (DisplayType c : DisplayType.values())
    System.out.println(c);

Returns:

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

valueOf

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

fromString

public static DisplayType fromString(String key)