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