Enum AuthenticationChallenge.Type

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CERTIFICATE_CHALLENGE
      This challenge is raised when an endpoint requires a client certificate to be presented.
      OAUTH_CREDENTIAL_CHALLENGE
      This challenge is raised when an endpoint is Token secured and requires a credential.
      SELF_SIGNED_CHALLENGE
      This challenge is raised when an endpoint presents an SSL certificate that is self signed or signed by an unknown root authority (for example an enterprise root certificate).
      UNKNOWN
      This value is used when the type of the authentication challenge cannot be determined from the available information (namely the exception that was raised).
      USER_CREDENTIAL_CHALLENGE
      This challenge is raised when a standard username/password credential is required to satisfy an HTTP or Token secured endpoint.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static AuthenticationChallenge.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AuthenticationChallenge.Type[] 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, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • USER_CREDENTIAL_CHALLENGE

        public static final AuthenticationChallenge.Type USER_CREDENTIAL_CHALLENGE
        This challenge is raised when a standard username/password credential is required to satisfy an HTTP or Token secured endpoint.
        Since:
        100.0.0
      • SELF_SIGNED_CHALLENGE

        public static final AuthenticationChallenge.Type SELF_SIGNED_CHALLENGE
        This challenge is raised when an endpoint presents an SSL certificate that is self signed or signed by an unknown root authority (for example an enterprise root certificate).
        Since:
        100.0.0
      • CERTIFICATE_CHALLENGE

        public static final AuthenticationChallenge.Type CERTIFICATE_CHALLENGE
        This challenge is raised when an endpoint requires a client certificate to be presented.
        Since:
        100.0.0
      • OAUTH_CREDENTIAL_CHALLENGE

        public static final AuthenticationChallenge.Type OAUTH_CREDENTIAL_CHALLENGE
        This challenge is raised when an endpoint is Token secured and requires a credential. This differs from the USER_CREDENTIAL_CHALLENGE in that it will only be issued if the calling portal (or the portal which federates the calling service) supports OAuth and you have set both a redirect URI and a client ID for the calling/federating portal in the AuthenticationManager.
        Since:
        100.0.0
      • UNKNOWN

        public static final AuthenticationChallenge.Type UNKNOWN
        This value is used when the type of the authentication challenge cannot be determined from the available information (namely the exception that was raised).
        Since:
        100.0.0
    • Method Detail

      • values

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

        public static AuthenticationChallenge.Type 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