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