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 */ 020package org.apache.directory.ldap.client.api.future; 021 022 023import java.util.concurrent.ExecutionException; 024import java.util.concurrent.TimeUnit; 025import java.util.concurrent.TimeoutException; 026 027import org.apache.directory.api.ldap.model.message.Response; 028import org.apache.directory.ldap.client.api.LdapConnection; 029 030 031/** 032 * A Future to manage SerachRequest. 033 * 034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 035 */ 036public class SearchFuture extends ResponseFuture<Response> 037{ 038 /** 039 * Creates a new instance of SearchFuture. 040 * 041 * @param connection the LDAP connection 042 * @param messageId The associated messageId 043 */ 044 public SearchFuture( LdapConnection connection, int messageId ) 045 { 046 super( connection, messageId ); 047 } 048 049 050 /** 051 * Get the SearchResponse, blocking until one is received, or until the 052 * given timeout is reached. It can be either a SearchResultEntry, 053 * a SearchResultReference or a SearchResultDone, the last of all 054 * the search responses. 055 * 056 * Get the ModifyResponse, blocking until one is received, or until the 057 * given timeout is reached. 058 * 059 * @param timeout {@inheritDoc} 060 * @param unit {@inheritDoc} 061 * @return the response, either a SearchResultEntry, a SearchResultReference, or a SearchResultDone 062 * @throws InterruptedException {@inheritDoc} 063 * @throws ExecutionException {@inheritDoc} 064 * @throws TimeoutException {@inheritDoc} 065 */ 066 public Response get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException, 067 TimeoutException 068 { 069 return super.get( timeout, unit ); 070 } 071 072 073 /** 074 * {@inheritDoc} 075 */ 076 public String toString() 077 { 078 StringBuilder sb = new StringBuilder(); 079 080 sb.append( "SearchFuture" ).append( super.toString() ); 081 082 return sb.toString(); 083 } 084}