Package io.jans.as.model.common

Enum ResponseMode

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

    • 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ResponseMode fromString​(java.lang.String param)  
      static ResponseMode getByValue​(java.lang.String value)  
      java.lang.String getParamName()  
      java.lang.String getValue()  
      java.lang.Enum<? extends io.jans.orm.annotation.AttributeEnum> resolveByValue​(java.lang.String value)  
      java.lang.String toString()  
      static ResponseMode valueOf​(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

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

      • 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:
        Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)

    • Method Detail

      • values

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

      • valueOf

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

      • getByValue

        public static ResponseMode getByValue​(java.lang.String value)

      • fromString

        public static ResponseMode fromString​(java.lang.String param)

      • toString

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

      • getValue

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

      • resolveByValue

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