Package com.unboundid.directory.sdk.ds.types

Enum PassThroughAuthenticationResultCode

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACCOUNT_NOT_USABLE
      Indicates that the pass-through authentication attempt filed because the mapped account in the external authentication service is not in a usable state (e.g., the password is expired, the account is locked, etc.).
      EXTERNAL_SERVICE_ERROR
      Indicates that the pass-through authentication attempt failed because the external service reported an error result.
      EXTERNAL_SERVICE_UNAVAILABLE
      Indicates that the pass-through authentication attempt failed because the external service is unavailable.
      HANDLER_NOT_APPLICABLE
      Indicates that the associated pass-through authentication handler is not applicable for the bind operation being processed.
      MUST_CHANGE_PASSWORD
      Indicates that the pass-through authentication attempt failed because the password for the mapped account must be changed before the account can be used.
      NO_SUCH_USER
      Indicates that the pass-through authentication attempt failed because the pass-through authentication handler could not identify exactly one account in the external service that corresponds to the account in the local server.
      NON_SPECIFIC_AUTHENTICATION_FAILURE
      Indicates that the pass-through authentication attempt failed, but the server did not provide enough information to identify a specific reason (e.g., whether the user doesn't exist, the wrong password was provided, the account is in an unusable state, etc.).
      OTHER_FAILURE
      Indicates that the pass-through authentication attempt failed for a reason that is not suited to any other defined result code.
      SUCCESS
      Indicates that pass-through authentication attempt succeeded.
      TIMEOUT
      Indicates that the pass-through authentication attempt failed because the external service did not return a response within an expected timeout period.
      WRONG_PASSWORD
      Indicates that the pass-through authentication attempt failed because the client provided the wrong password for the target user.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PassThroughAuthenticationResultCode forName​(java.lang.String name)
      Retrieves the PassThroughAuthenticationResultCode value that corresponds to the provided name.
      java.lang.String getName()
      Retrieves the human-readable name for this result code.
      java.lang.String toString()
      Retrieves the human-readable name for this IndexType.
      static PassThroughAuthenticationResultCode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PassThroughAuthenticationResultCode[] 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

    • Method Detail

      • values

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

      • valueOf

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

      • getName

        @NotNull
public java.lang.String getName()
        Retrieves the human-readable name for this result code.
        Returns:
        The human-readable name for this result code.

      • forName

        @Nullable
public static PassThroughAuthenticationResultCode forName​(@NotNull
                                                          java.lang.String name)
        Retrieves the PassThroughAuthenticationResultCode value that corresponds to the provided name.
        Parameters:
        name - The name for which to retrieve the corresponding result code. It must not be null.
        Returns:
        The requested result code value, or null if there is no result code with the provided name.