View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.ldap.model.message;
21  
22  
23  /**
24   * A request which can be abandoned.
25   * 
26   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
27   */
28  public interface AbandonableRequest extends Request
29  {
30      /**
31       * Abandons this request.
32       */
33      void abandon();
34  
35  
36      /**
37       * Checks to see if this request has been abandoned.
38       * 
39       * @return true if the request has been abandoned.
40       */
41      boolean isAbandoned();
42  
43  
44      /**
45       * Adds listener to be notified if this request gets abandoned.
46       * 
47       * @param listener to be notified if this request gets abandoned.
48       * @return An AbandonableRequest reference
49       */
50      AbandonableRequest addAbandonListener( AbandonListener listener );
51  }