Package io.jans.as.model.common

Enum Display

  • All Implemented Interfaces:
    HasParamName, java.io.Serializable, java.lang.Comparable<Display>
    public enum Display
extends java.lang.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

    • 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Display fromString​(java.lang.String param)
      Returns the corresponding Display for a parameter display of the authorization endpoint.
      java.lang.String getParamName()  
      java.lang.String toString()
      Returns a string representation of the object.
      static Display valueOf​(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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.

      • POPUP

        public static final Display POPUP
        The Authorization Server SHOULD display authentication and consent UI consistent with a popup user-agent window. The popup user-agent window SHOULD be 450 pixels wide and 500 pixels tall.

      • 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 Detail

      • values

        public static Display[] 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 (Display c : Display.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Display valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • fromString

        public static Display fromString​(java.lang.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 java.lang.String toString()
        Returns a string representation of the object. In this case the parameter name.
        Overrides:
        toString in class java.lang.Enum<Display>