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 2011 ForgeRock AS 025 */ 026 027package org.forgerock.opendj.ldap; 028 029import java.util.EventListener; 030 031import org.forgerock.i18n.LocalizableMessage; 032 033/** 034 * An object that registers to be notified when a cancellation request has been 035 * received and processing of the request should be aborted if possible. 036 * <p> 037 * Requests may be cancelled as a result of an abandon request or a cancel 038 * extended request sent from the client, or by the server itself (e.g. during 039 * server shutdown). 040 */ 041public interface CancelRequestListener extends EventListener { 042 /** 043 * Invoked when a cancellation request has been received and processing of 044 * the request should be aborted if possible. 045 * <p> 046 * Requests may be cancelled as a result of an abandon request or a cancel 047 * extended request sent from the client, or by the server itself (e.g. 048 * during server shutdown). 049 * <p> 050 * Implementations should, if possible, abort further processing of the 051 * request and return an appropriate cancellation result. 052 * 053 * @param cancellationReason 054 * A message describing the reason why the request is being 055 * cancelled. 056 */ 057 void handleCancelRequest(LocalizableMessage cancellationReason); 058}