Package io.jans.as.model.common

Enum Display

java.lang.Object
java.lang.Enum<Display>
io.jans.as.model.common.Display
All Implemented Interfaces:
HasParamName, Serializable, Comparable<Display>, java.lang.constant.Constable
public enum Display extends Enum<Display> implements HasParamName
An ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.
Author:
Javier Rojas Blum Date: 02.10.2012

  • 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
    EMBEDDED
    The Authorization Server SHOULD display authentication and consent UI consistent with the limitations of an embedded user-agent.
    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 Display
    fromString(String param)
    Returns the corresponding Display for a parameter display of the authorization endpoint.
    String
    getParamName()
     
    String
    toString()
    Returns a string representation of the object.
    static Display
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Display[]
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PAGE

      public static final Display 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.

    • TOUCH

      public static final Display TOUCH
      The Authorization Server SHOULD display authentication and consent UI consistent with a device that leverages a touch interface. The Authorization Server MAY attempt to detect the touch device and further customize the interface.

    • WAP

      public static final Display WAP
      The Authorization Server SHOULD display authentication and consent UI consistent with a "feature phone" type display.

    • EMBEDDED

      public static final Display EMBEDDED
      The Authorization Server SHOULD display authentication and consent UI consistent with the limitations of an embedded user-agent.

  • Method Details

    • values

      public static Display[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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

    • getParamName

      public String getParamName()
      Specified by:
      getParamName in interface HasParamName

    • fromString

      public static Display fromString(String param)
      Returns the corresponding Display for a parameter display of the authorization endpoint.
      Parameters:
      param - The parameter.
      Returns:
      The corresponding response type if found, otherwise null.

    • toString

      public String toString()
      Returns a string representation of the object. In this case the parameter name.
      Overrides:
      toString in class Enum<Display>