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     */
020    package org.apache.directory.api.ldap.model.message;
021    
022    
023    /**
024     * A request which can be abandoned.
025     * 
026     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
027     */
028    public interface AbandonableRequest extends Request
029    {
030        /**
031         * Abandons this request.
032         */
033        void abandon();
034    
035    
036        /**
037         * Checks to see if this request has been abandoned.
038         * 
039         * @return true if the request has been abandoned.
040         */
041        boolean isAbandoned();
042    
043    
044        /**
045         * Adds listener to be notified if this request gets abandoned.
046         * 
047         * @param listener to be notified if this request gets abandoned.
048         * @return An AbandonableRequest reference
049         */
050        AbandonableRequest addAbandonListener( AbandonListener listener );
051    }