| /* |
| * 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 |
| * |
| * https://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.Future; |
| |
| import org.apache.directory.api.ldap.model.message.Response; |
| |
| |
| /** |
| * A Future implementation used in LdapConnection operations. |
| * |
| * @param <R> The result type returned by this Future's <tt>get</tt> method |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| public interface ResponseFuture<R extends Response> extends Future<R> |
| { |
| /** |
| * Set the associated Response in this Future |
| * |
| * @param response The response to add into the Future |
| * @throws InterruptedException if the operation has been cancelled by client |
| */ |
| void set( R response ) throws InterruptedException; |
| |
| |
| /** |
| * @return the cause |
| */ |
| Throwable getCause(); |
| |
| |
| /** |
| * Associate a cause to the ResponseFuture |
| * @param cause the cause to set |
| */ |
| void setCause( Throwable cause ); |
| |
| |
| /** |
| * Cancel the Future |
| * |
| */ |
| void cancel(); |
| } |