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 2010 Sun Microsystems, Inc.
015 * Portions Copyright 2014 ForgeRock AS.
016 */
017
018package org.forgerock.opendj.ldap;
019
020import org.forgerock.opendj.ldap.responses.Result;
021
022/**
023 * Thrown when the result code returned in a Result indicates that the Request
024 * failed due to an authorization failure. More specifically, this exception is
025 * used for the following error result codes:
026 * <ul>
027 * <li>{@link ResultCode#AUTHORIZATION_DENIED AUTHORIZATION_DENIED} - the
028 * Request failed because the server has not allowed the client to use the
029 * requested authorization.
030 * <li>{@link ResultCode#CONFIDENTIALITY_REQUIRED CONFIDENTIALITY_REQUIRED} -
031 * the Request failed because it requires confidentiality for the communication
032 * between the client and the server.
033 * <li>{@link ResultCode#INSUFFICIENT_ACCESS_RIGHTS INSUFFICIENT_ACCESS_RIGHTS}
034 * - the Request failed because the client does not have sufficient permission
035 * to perform the requested operation.
036 * <li>{@link ResultCode#STRONG_AUTH_REQUIRED STRONG_AUTH_REQUIRED} - the
037 * Request failed because it requires that the client has completed a strong
038 * form of authentication.
039 * </ul>
040 */
041@SuppressWarnings("serial")
042public class AuthorizationException extends LdapException {
043    AuthorizationException(final Result result) {
044        super(result);
045    }
046}