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