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 2015 ForgeRock AS.
026 */
027package org.forgerock.opendj.config.client;
028
029import org.forgerock.i18n.LocalizableMessage;
030
031import static com.forgerock.opendj.ldap.config.AdminMessages.*;
032
033/**
034 * This exception is thrown when an authentication error occurs while connecting
035 * to the Directory Server. An authentication error can happen, for example,
036 * when the client credentials are invalid.
037 */
038public class AuthenticationException extends AdminSecurityException {
039
040    /**
041     * Serialization ID.
042     */
043    private static final long serialVersionUID = 3544797197747686958L;
044
045    /**
046     * Creates an authentication exception with a default message.
047     */
048    public AuthenticationException() {
049        super(ERR_AUTHENTICATION_EXCEPTION_DEFAULT.get());
050    }
051
052    /**
053     * Create an authentication exception with a cause and a default 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     * Create an authentication exception with a message and cause.
064     *
065     * @param message
066     *            The message.
067     * @param cause
068     *            The cause.
069     */
070    public AuthenticationException(LocalizableMessage message, Throwable cause) {
071        super(message, cause);
072    }
073
074    /**
075     * Create an authentication exception with a message.
076     *
077     * @param message
078     *            The message.
079     */
080    public AuthenticationException(LocalizableMessage message) {
081        super(message);
082    }
083}