Package io.jans.as.model.common

Enum AuthenticationMethod

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AuthenticationMethod>
    public enum AuthenticationMethod
extends java.lang.Enum<AuthenticationMethod>
    Author:
    Javier Rojas Blum Date: 03.23.2012

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACCESS_TOKEN
      Authenticates client by access token.
      CLIENT_SECRET_BASIC
      Clients in possession of a client password authenticate with the Authorization Server using HTTP Basic authentication scheme.
      CLIENT_SECRET_JWT
      Clients in possession of a client password create a JWT using the HMAC-SHA algorithm.
      CLIENT_SECRET_POST
      Clients in possession of a client password authenticate with the Authorization Server by including the client credentials in the request body.
      NONE
      The Client does not authenticate itself at the Token Endpoint, either because it uses only the Implicit Flow (and so does not use the Token Endpoint) or because it is a Public Client with no Client Secret or other authentication mechanism.
      PRIVATE_KEY_JWT
      Clients that have registered a public key sign a JWT using the RSA algorithm if a RSA key was registered or the ECDSA algorithm if an Elliptic Curve key was registered.
      SELF_SIGNED_TLS_CLIENT_AUTH
      Indicates that client authentication to the authorization server will occur using mutual TLS with the client utilizing a self- signed certificate.
      TLS_CLIENT_AUTH
      Indicates that client authentication to the authorization server will occur with mutual TLS utilizing the PKI method of associating a certificate to a client.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AuthenticationMethod fromString​(java.lang.String param)
      Returns the corresponding AuthenticationMethod for an authentication method parameter.
      java.lang.String toString()
      Returns a string representation of the object.
      static AuthenticationMethod valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AuthenticationMethod[] 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

      • CLIENT_SECRET_BASIC

        public static final AuthenticationMethod CLIENT_SECRET_BASIC
        Clients in possession of a client password authenticate with the Authorization Server using HTTP Basic authentication scheme. Default one if not client authentication is specified.

      • CLIENT_SECRET_POST

        public static final AuthenticationMethod CLIENT_SECRET_POST
        Clients in possession of a client password authenticate with the Authorization Server by including the client credentials in the request body.

      • CLIENT_SECRET_JWT

        public static final AuthenticationMethod CLIENT_SECRET_JWT
        Clients in possession of a client password create a JWT using the HMAC-SHA algorithm. The HMAC (Hash-based Message Authentication Code) is calculated using the client_secret as the shared key.

      • PRIVATE_KEY_JWT

        public static final AuthenticationMethod PRIVATE_KEY_JWT
        Clients that have registered a public key sign a JWT using the RSA algorithm if a RSA key was registered or the ECDSA algorithm if an Elliptic Curve key was registered.

      • ACCESS_TOKEN

        public static final AuthenticationMethod ACCESS_TOKEN
        Authenticates client by access token.

      • TLS_CLIENT_AUTH

        public static final AuthenticationMethod TLS_CLIENT_AUTH
        Indicates that client authentication to the authorization server will occur with mutual TLS utilizing the PKI method of associating a certificate to a client.

      • SELF_SIGNED_TLS_CLIENT_AUTH

        public static final AuthenticationMethod SELF_SIGNED_TLS_CLIENT_AUTH
        Indicates that client authentication to the authorization server will occur using mutual TLS with the client utilizing a self- signed certificate.

      • NONE

        public static final AuthenticationMethod NONE
        The Client does not authenticate itself at the Token Endpoint, either because it uses only the Implicit Flow (and so does not use the Token Endpoint) or because it is a Public Client with no Client Secret or other authentication mechanism.

    • Method Detail

      • values

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

      • valueOf

        public static AuthenticationMethod 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 AuthenticationMethod fromString​(java.lang.String param)
        Returns the corresponding AuthenticationMethod for an authentication method parameter.
        Parameters:
        param - The parameter.
        Returns:
        The corresponding authentication method if found, otherwise null.

      • toString

        public java.lang.String toString()
        Returns a string representation of the object. In this case the parameter name for the authentication method parameter.
        Overrides:
        toString in class java.lang.Enum<AuthenticationMethod>