001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.shared.ldap.model.message;
021
022
023
024/**
025 * A request which can be abandoned.
026 * 
027 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028 */
029public interface AbandonableRequest extends Request
030{
031    /**
032     * Abandons this request.
033     */
034    void abandon();
035
036
037    /**
038     * Checks to see if this request has been abandoned.
039     * 
040     * @return true if the request has been abandoned.
041     */
042    boolean isAbandoned();
043
044
045    /**
046     * Adds listener to be notified if this request gets abandoned.
047     * 
048     * @param listener to be notified if this request gets abandoned.
049     * @return An AbandonableRequest reference
050     */
051    AbandonableRequest addAbandonListener( AbandonListener listener );
052}