001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2010 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027
028package org.forgerock.opendj.ldap;
029
030import org.forgerock.opendj.ldap.responses.Result;
031
032/**
033 * Thrown when the result code returned in a Result indicates that the Bind
034 * Request failed due to an authentication failure. More specifically, this
035 * exception is used for the following error result codes:
036 * <ul>
037 * <li>{@link ResultCode#AUTH_METHOD_NOT_SUPPORTED AUTH_METHOD_NOT_SUPPORTED} -
038 * the Bind request failed because it referenced an invalid SASL mechanism.
039 * <li>{@link ResultCode#CLIENT_SIDE_AUTH_UNKNOWN CLIENT_SIDE_AUTH_UNKNOWN} -
040 * the Bind request failed because the user requested an authentication
041 * mechanism which is unknown or unsupported by the OpenDJ SDK.
042 * <li>{@link ResultCode#INAPPROPRIATE_AUTHENTICATION
043 * INAPPROPRIATE_AUTHENTICATION} - the Bind request failed because the requested
044 * type of authentication was not appropriate for the targeted entry.
045 * <li>{@link ResultCode#INVALID_CREDENTIALS INVALID_CREDENTIALS} - the Bind
046 * request failed because the user did not provide a valid set of credentials.
047 * </ul>
048 */
049@SuppressWarnings("serial")
050public class AuthenticationException extends LdapException {
051    AuthenticationException(final Result result) {
052        super(result);
053    }
054}