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.ldap.client.api.future;
21  
22  
23  import java.util.concurrent.ExecutionException;
24  import java.util.concurrent.TimeUnit;
25  import java.util.concurrent.TimeoutException;
26  
27  import org.apache.directory.api.ldap.model.message.Response;
28  import org.apache.directory.ldap.client.api.LdapConnection;
29  
30  
31  /**
32   * A Future to manage ExtendedRequests.
33   *
34   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35   */
36  public class ExtendedFuture extends ResponseFuture<Response>
37  {
38      /**
39       * Creates a new instance of ExtendedFuture.
40       *
41       * @param connection the LDAP connection
42       * @param messageId The associated messageId
43       */
44      public ExtendedFuture( LdapConnection connection, int messageId )
45      {
46          super( connection, messageId );
47      }
48  
49  
50      /**
51       * Get the ExtendedResponse, blocking until one is received, or until the
52       * given timeout is reached.
53       *
54       * @param timeout {@inheritDoc}
55       * @param unit {@inheritDoc}
56       * @return the extended response
57       * @throws InterruptedException {@inheritDoc}
58       * @throws ExecutionException {@inheritDoc}
59       * @throws TimeoutException {@inheritDoc}
60       */
61      public Response get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
62          TimeoutException
63      {
64          return super.get( timeout, unit );
65      }
66  
67  
68      /**
69       * {@inheritDoc}
70       */
71      public String toString()
72      {
73          StringBuilder sb = new StringBuilder();
74  
75          sb.append( "ExtendedFuture" ).append( super.toString() );
76  
77          return sb.toString();
78      }
79  }