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 SerachRequest.
33 *
34 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35 */
36 public class SearchFuture extends ResponseFuture<Response>
37 {
38 /**
39 * Creates a new instance of SearchFuture.
40 *
41 * @param connection the LDAP connection
42 * @param messageId The associated messageId
43 */
44 public SearchFuture( LdapConnection connection, int messageId )
45 {
46 super( connection, messageId );
47 }
48
49
50 /**
51 * Get the SearchResponse, blocking until one is received, or until the
52 * given timeout is reached. It can be either a SearchResultEntry,
53 * a SearchResultReference or a SearchResultDone, the last of all
54 * the search responses.
55 *
56 * Get the ModifyResponse, blocking until one is received, or until the
57 * given timeout is reached.
58 *
59 * @param timeout {@inheritDoc}
60 * @param unit {@inheritDoc}
61 * @return the response, either a SearchResultEntry, a SearchResultReference, or a SearchResultDone
62 * @throws InterruptedException {@inheritDoc}
63 * @throws ExecutionException {@inheritDoc}
64 * @throws TimeoutException {@inheritDoc}
65 */
66 public Response get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
67 TimeoutException
68 {
69 return super.get( timeout, unit );
70 }
71
72
73 /**
74 * {@inheritDoc}
75 */
76 public String toString()
77 {
78 StringBuilder sb = new StringBuilder();
79
80 sb.append( "SearchFuture" ).append( super.toString() );
81
82 return sb.toString();
83 }
84 }