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 2015-2016 ForgeRock AS.
016 */
017package org.forgerock.opendj.config.client;
018
019import org.forgerock.i18n.LocalizableMessage;
020
021import static com.forgerock.opendj.ldap.config.ConfigMessages.*;
022
023/**
024 * This exception is thrown when an authentication error occurs while connecting
025 * to the Directory Server. An authentication error can happen, for example,
026 * when the client credentials are invalid.
027 */
028public class AuthenticationException extends AdminSecurityException {
029
030    /** Serialization ID. */
031    private static final long serialVersionUID = 3544797197747686958L;
032
033    /** Creates an authentication exception with a default message. */
034    public AuthenticationException() {
035        super(ERR_AUTHENTICATION_EXCEPTION_DEFAULT.get());
036    }
037
038    /**
039     * Create an authentication exception with a cause and a default message.
040     *
041     * @param cause
042     *            The cause.
043     */
044    public AuthenticationException(Throwable cause) {
045        super(ERR_AUTHENTICATION_EXCEPTION_DEFAULT.get(), cause);
046    }
047
048    /**
049     * Create an authentication exception with a message and cause.
050     *
051     * @param message
052     *            The message.
053     * @param cause
054     *            The cause.
055     */
056    public AuthenticationException(LocalizableMessage message, Throwable cause) {
057        super(message, cause);
058    }
059
060    /**
061     * Create an authentication exception with a message.
062     *
063     * @param message
064     *            The message.
065     */
066    public AuthenticationException(LocalizableMessage message) {
067        super(message);
068    }
069}