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 2009-2010 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027
028package org.forgerock.opendj.ldap;
029
030import org.forgerock.opendj.ldap.responses.Result;
031
032/**
033 * Thrown when the result code returned in a Result indicates that the Request
034 * was cancelled. More specifically, this exception is used for the following
035 * error result codes:
036 * <ul>
037 * <li>{@link ResultCode#CANCELLED CANCELLED} - the requested operation was
038 * cancelled.
039 * <li>{@link ResultCode#CLIENT_SIDE_USER_CANCELLED CLIENT_SIDE_USER_CANCELLED}
040 * - the requested operation was cancelled by the user.
041 * </ul>
042 */
043@SuppressWarnings("serial")
044public class CancelledResultException extends LdapException {
045    CancelledResultException(final Result result) {
046        super(result);
047    }
048}