trunk/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/SearchFuture.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.ldap.client.api.future;


import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import org.apache.directory.api.ldap.model.message.Response;
import org.apache.directory.ldap.client.api.LdapConnection;


/**
 * A Future to manage SerachRequest.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class SearchFuture extends ResponseFuture<Response>
{
    /**
     * Creates a new instance of SearchFuture.
     *
     * @param connection the LDAP connection
     * @param messageId The associated messageId
     */
    public SearchFuture( LdapConnection connection, int messageId )
    {
        super( connection, messageId );
    }


    /**
     * Get the SearchResponse, blocking until one is received, or until the
     * given timeout is reached. It can be either a SearchResultEntry, 
     * a SearchResultReference or a SearchResultDone, the last of all 
     * the search responses.
     * 
     * Get the ModifyResponse, blocking until one is received, or until the
     * given timeout is reached.
     *
     * @param timeout {@inheritDoc}
     * @param unit {@inheritDoc}
     * @return the response, either a SearchResultEntry, a SearchResultReference, or a SearchResultDone
     * @throws InterruptedException {@inheritDoc}
     * @throws ExecutionException {@inheritDoc}
     * @throws TimeoutException {@inheritDoc}
     */
    public Response get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
        TimeoutException
    {
        return super.get( timeout, unit );
    }


    /**
     * {@inheritDoc}
     */
    public String toString()
    {
        StringBuilder sb = new StringBuilder();

        sb.append( "SearchFuture" ).append( super.toString() );

        return sb.toString();
    }
}