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