Package io.jans.as.model.common

Enum ResponseMode

java.lang.Object
java.lang.Enum<ResponseMode>
io.jans.as.model.common.ResponseMode
All Implemented Interfaces:
HasParamName, io.jans.orm.annotation.AttributeEnum, Serializable, Comparable<ResponseMode>, java.lang.constant.Constable
public enum ResponseMode extends Enum<ResponseMode> implements HasParamName, io.jans.orm.annotation.AttributeEnum
Version:
July 28, 2021
Author:
Javier Rojas Blum

  • 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
    FORM_POST
    In this mode, Authorization Response parameters are encoded as HTML form values that are auto-submitted in the User Agent, and thus are transmitted via the HTTP POST method to the Client, with the result parameters being encoded in the body using the application/x-www-form-urlencoded format.
    FORM_POST_JWT
    In this mode, Authorization server uses the OAuth 2.0 Form Post Response Mode technique to convey the JWT to the client.
    FRAGMENT
    In this mode, Authorization Response parameters are encoded in the fragment added to the redirect_uri when redirecting back to the Client.
    FRAGMENT_JWT
    In this mode, Authorization server sends tha authorization response as HTTP redirect to the redirect URI of the client.
    JWT
    The respose mode "jwt" is a shortcut and indicates the default redirect encoding (query, fragment) for the requested response type.
    QUERY
    In this mode, Authorization Response parameters are encoded in the query string added to the redirect_uri when redirecting back to the Client.
    QUERY_JWT
    In this mode, Authorization server sends the authorization response as HTTP redirect to the redirect URI of the client.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ResponseMode
    fromString(String param)
     
    static ResponseMode
    getByValue(String value)
     
    String
    getParamName()
     
    String
    getValue()
     
    Enum<? extends io.jans.orm.annotation.AttributeEnum>
    resolveByValue(String value)
     
    String
    toString()
     
    static ResponseMode
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static ResponseMode[]
    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

    • QUERY

      public static final ResponseMode QUERY
      In this mode, Authorization Response parameters are encoded in the query string added to the redirect_uri when redirecting back to the Client.

    • FRAGMENT

      public static final ResponseMode FRAGMENT
      In this mode, Authorization Response parameters are encoded in the fragment added to the redirect_uri when redirecting back to the Client.

    • FORM_POST

      public static final ResponseMode FORM_POST
      In this mode, Authorization Response parameters are encoded as HTML form values that are auto-submitted in the User Agent, and thus are transmitted via the HTTP POST method to the Client, with the result parameters being encoded in the body using the application/x-www-form-urlencoded format.

    • QUERY_JWT

      public static final ResponseMode QUERY_JWT
      In this mode, Authorization server sends the authorization response as HTTP redirect to the redirect URI of the client. The authorization server adds the parameter response containing the JWT to the query component of the redirect URI using the "application/x-form-urlencoded" format.
      See Also:

    • FRAGMENT_JWT

      public static final ResponseMode FRAGMENT_JWT
      In this mode, Authorization server sends tha authorization response as HTTP redirect to the redirect URI of the client. The authorization server adds the parameter response containing the JWT to the fragment component of the redirect URI using the "application/x-form-encoded" format.
      See Also:

    • FORM_POST_JWT

      public static final ResponseMode FORM_POST_JWT
      In this mode, Authorization server uses the OAuth 2.0 Form Post Response Mode technique to convey the JWT to the client. The response parameter containing the JWT is encoded as HTML form value that is auto-submitted in the User Agent, and thus is transmitted via the HTTP POST method to the Client, with the result parameters being encoded in the body using the "application/x-form.encoded" format.
      See Also:

    • JWT

      public static final ResponseMode JWT
      The respose mode "jwt" is a shortcut and indicates the default redirect encoding (query, fragment) for the requested response type. The default for response type "code" is "query.jwt" whereas the default for "token" and the response types defined is "fragment.jwt".
      See Also:

  • Method Details

    • values

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

    • getByValue

      public static ResponseMode getByValue(String value)

    • fromString

      public static ResponseMode fromString(String param)

    • getParamName

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

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ResponseMode>

    • getValue

      public String getValue()
      Specified by:
      getValue in interface io.jans.orm.annotation.AttributeEnum

    • resolveByValue

      public Enum<? extends io.jans.orm.annotation.AttributeEnum> resolveByValue(String value)
      Specified by:
      resolveByValue in interface io.jans.orm.annotation.AttributeEnum