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 * https://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.Future; 024 025import org.apache.directory.api.ldap.model.message.Response; 026 027 028/** 029 * A Future implementation used in LdapConnection operations. 030 * 031 * @param <R> The result type returned by this Future's <tt>get</tt> method 032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 033 */ 034public interface ResponseFuture<R extends Response> extends Future<R> 035{ 036 /** 037 * Set the associated Response in this Future 038 * 039 * @param response The response to add into the Future 040 * @throws InterruptedException if the operation has been cancelled by client 041 */ 042 void set( R response ) throws InterruptedException; 043 044 045 /** 046 * @return the cause 047 */ 048 Throwable getCause(); 049 050 051 /** 052 * Associate a cause to the ResponseFuture 053 * @param cause the cause to set 054 */ 055 void setCause( Throwable cause ); 056 057 058 /** 059 * Cancel the Future 060 * 061 */ 062 void cancel(); 063}