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 2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027
028package org.opends.server.admin.client;
029
030
031
032import static org.opends.messages.AdminMessages.*;
033
034import org.forgerock.i18n.LocalizableMessage;
035
036
037
038/**
039 * This exception is thrown when an authentication error occurs while
040 * connecting to the Directory Server. An authentication error can
041 * happen, for example, when the client credentials are invalid.
042 */
043public class AuthenticationException extends AdminSecurityException {
044
045  /**
046   * Serialization ID.
047   */
048  private static final long serialVersionUID = 3544797197747686958L;
049
050
051
052  /**
053   * Creates an authentication exception with a default message.
054   */
055  public AuthenticationException() {
056    super(ERR_AUTHENTICATION_EXCEPTION_DEFAULT.get());
057  }
058
059
060
061  /**
062   * Create an authentication exception with a cause and a default
063   * message.
064   *
065   * @param cause
066   *          The cause.
067   */
068  public AuthenticationException(Throwable cause) {
069    super(ERR_AUTHENTICATION_EXCEPTION_DEFAULT.get(), cause);
070  }
071
072
073
074  /**
075   * Create an authentication exception with a message and cause.
076   *
077   * @param message
078   *          The message.
079   * @param cause
080   *          The cause.
081   */
082  public AuthenticationException(LocalizableMessage message, Throwable cause) {
083    super(message, cause);
084  }
085
086
087
088  /**
089   * Create an authentication exception with a message.
090   *
091   * @param message
092   *          The message.
093   */
094  public AuthenticationException(LocalizableMessage message) {
095    super(message);
096  }
097}