Package com.unboundid.ldap.sdk.unboundidds.controls

Class AuthenticationFailureReason

  • All Implemented Interfaces:
    java.io.Serializable
    @NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AuthenticationFailureReason
extends java.lang.Object
implements java.io.Serializable
    This class defines a data structure that will provide information about errors that could cause an authentication attempt to fail. It includes a number of predefined failure types, but also allows for the possibility of additional failure types that have not been defined.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String FAILURE_NAME_ACCOUNT_NOT_USABLE
      The name for the failure type that indicates the user's account is not in a usable state.
      static java.lang.String FAILURE_NAME_CANNOT_ASSIGN_CLIENT_CONNECTION_POLICY
      The name for the failure type that indicates that the server was unable to assign a client connection policy for the user.
      static java.lang.String FAILURE_NAME_CANNOT_IDENTIFY_USER
      The numeric value for the failure type that indicates that the server was unable to identify the user specified as the authentication or authorization identity.
      static java.lang.String FAILURE_NAME_CONSTRAINT_VIOLATION
      The name for the failure type that indicates that bind was not permitted by some constraint defined in the server (password policy, client connection policy, operational attributes in the user entry, etc.).
      static java.lang.String FAILURE_NAME_CONTROL_PROBLEM
      The name for the failure type that indicates that there was a problem with a control included in the bind request.
      static java.lang.String FAILURE_NAME_IMPROPER_SASL_CREDENTIALS
      The name for the failure type that indicates that there was a problem with the SASL credentials provided to the server (e.g., they were malformed, out of sequence, or otherwise invalid).
      static java.lang.String FAILURE_NAME_INSUFFICIENT_ACCESS_RIGHTS
      The name for the failure type that indicates that the bind was not permitted by the server's access control configuration.
      static java.lang.String FAILURE_NAME_INVALID_CREDENTIALS
      The name for the failure type that indicates that the user provided an incorrect password or other form of invalid credentials.
      static java.lang.String FAILURE_NAME_LOCKDOWN_MODE
      The name for the failure type that indicates that the server is in lockdown mode and will only permit authentication for a limited set of administrators.
      static java.lang.String FAILURE_NAME_OTHER
      The name for a failure type that does not fit into any other of the defined failure types.
      static java.lang.String FAILURE_NAME_PASS_THROUGH_AUTH_FAILURE
      The name for the failure type that indicates that a pass-through authentication attempt failed.
      static java.lang.String FAILURE_NAME_PASSWORD_FAILED_VALIDATION
      The name for the failure type that indicates that the bind request used a password that did not satisfy the configured set of password validators.
      static java.lang.String FAILURE_NAME_SECURE_AUTHENTICATION_REQUIRED
      The name for the failure type that indicates that the user will only be permitted to authenticate in a secure manner.
      static java.lang.String FAILURE_NAME_SECURITY_PROBLEM
      The name for the failure type that indicates that the bind request used a security-related problem was encountered while processing the bind operation.
      static java.lang.String FAILURE_NAME_SERVER_ERROR
      The name for the failure type that indicates that a server error occurred while processing the bind operation.
      static java.lang.String FAILURE_NAME_THIRD_PARTY_SASL_AUTHENTICATION_FAILURE
      The name for the failure type that indicates that a third-party SASL mechanism handler failed to authenticate the user.
      static java.lang.String FAILURE_NAME_UNAVAILABLE_AUTHENTICATION_TYPE
      The name for the failure type that indicates that the attempted authentication type is not available for the target user.
      static int FAILURE_TYPE_ACCOUNT_NOT_USABLE
      The numeric value for the failure type that indicates the user's account is not in a usable state.
      static int FAILURE_TYPE_CANNOT_ASSIGN_CLIENT_CONNECTION_POLICY
      The numeric value for the failure type that indicates that the server was unable to assign a client connection policy for the user.
      static int FAILURE_TYPE_CANNOT_IDENTIFY_USER
      The numeric value for the failure type that indicates that the server was unable to identify the user specified as the authentication or authorization identity.
      static int FAILURE_TYPE_CONSTRAINT_VIOLATION
      The numeric value for the failure type that indicates that bind was not permitted by some constraint defined in the server (password policy, client connection policy, operational attributes in the user entry, etc.).
      static int FAILURE_TYPE_CONTROL_PROBLEM
      The numeric value for the failure type that indicates that there was a problem with a control included in the bind request.
      static int FAILURE_TYPE_IMPROPER_SASL_CREDENTIALS
      The numeric value for the failure type that indicates that there was a problem with the SASL credentials provided to the server (e.g., they were malformed, out of sequence, or otherwise invalid).
      static int FAILURE_TYPE_INSUFFICIENT_ACCESS_RIGHTS
      The numeric value for the failure type that indicates that the bind was not permitted by the server's access control configuration.
      static int FAILURE_TYPE_INVALID_CREDENTIALS
      The numeric value for the failure type that indicates that the user provided an incorrect password or other form of invalid credentials.
      static int FAILURE_TYPE_LOCKDOWN_MODE
      The numeric value for the failure type that indicates that the server is in lockdown mode and will only permit authentication for a limited set of administrators.
      static int FAILURE_TYPE_OTHER
      The numeric value for a failure type that does not fit into any other of the defined failure types.
      static int FAILURE_TYPE_PASS_THROUGH_AUTH_FAILURE
      The numeric value for the failure type that indicates that a pass-through authentication attempt failed.
      static int FAILURE_TYPE_PASSWORD_FAILED_VALIDATION
      The numeric value for the failure type that indicates that the bind request used a password that did not satisfy the configured set of password validators.
      static int FAILURE_TYPE_SECURE_AUTHENTICATION_REQUIRED
      The numeric value for the failure type that indicates that the user will only be permitted to authenticate in a secure manner.
      static int FAILURE_TYPE_SECURITY_PROBLEM
      The numeric value for the failure type that indicates that a security-related problem was encountered while processing the bind operation.
      static int FAILURE_TYPE_SERVER_ERROR
      The numeric value for the failure type that indicates that a server error occurred while processing the bind operation.
      static int FAILURE_TYPE_THIRD_PARTY_SASL_AUTHENTICATION_FAILURE
      The numeric value for the failure type that indicates that a third-party SASL mechanism handler failed to authenticate the user.
      static int FAILURE_TYPE_UNAVAILABLE_AUTHENTICATION_TYPE
      The numeric value for the failure type that indicates that the attempted authentication type is not available for the target user.

    • Constructor Summary

      Constructors 
      Constructor Description
      AuthenticationFailureReason​(int intValue, java.lang.String name, java.lang.String message)
      Creates a new authentication failure reason with the provided information.
      AuthenticationFailureReason​(java.lang.String stringRepresentation)
      Creates a new authentication failure reason that is decoded from the provided string representation.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getIntValue()
      Retrieves the integer value for this authentication failure reason.
      java.lang.String getMessage()
      Retrieves a human-readable message that provides specific details about this authentication failure reason.
      java.lang.String getName()
      Retrieves the name for this authentication failure reason.
      java.lang.String toString()
      Retrieves a string representation of this authentication failure reason.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • AuthenticationFailureReason

        public AuthenticationFailureReason​(int intValue,
                                   @NotNull
                                   java.lang.String name,
                                   @Nullable
                                   java.lang.String message)
        Creates a new authentication failure reason with the provided information.
        Parameters:
        intValue - The integer value for this authentication failure reason.
        name - The name for this authentication failure reason. It must not be null.
        message - A human-readable message that provides specific details about this account usability error. It may be null if no message is available.

      • AuthenticationFailureReason

        public AuthenticationFailureReason​(@NotNull
                                   java.lang.String stringRepresentation)
                            throws LDAPException
        Creates a new authentication failure reason that is decoded from the provided string representation.
        Parameters:
        stringRepresentation - The string representation of the authentication failure reason to decode. It must not be null.
        Throws:
        LDAPException - If the provided string cannot be decoded as a valid authentication failure reason.

    • Method Detail

      • getIntValue

        public int getIntValue()
        Retrieves the integer value for this authentication failure reason.
        Returns:
        The integer value for this authentication failure reason.

      • getName

        @NotNull
public java.lang.String getName()
        Retrieves the name for this authentication failure reason.
        Returns:
        The name for this authentication failure reason.

      • getMessage

        @Nullable
public java.lang.String getMessage()
        Retrieves a human-readable message that provides specific details about this authentication failure reason.
        Returns:
        A human-readable message that provides specific details about this authentication failure reason, or null if no message is available.

      • toString

        @NotNull
public java.lang.String toString()
        Retrieves a string representation of this authentication failure reason.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this authentication failure reason.