1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 package org.apache.hc.client5.http.async; 28 29 import java.util.concurrent.Future; 30 31 import org.apache.hc.core5.concurrent.FutureCallback; 32 import org.apache.hc.core5.http.nio.AsyncPushConsumer; 33 import org.apache.hc.core5.http.nio.AsyncRequestProducer; 34 import org.apache.hc.core5.http.nio.AsyncResponseConsumer; 35 import org.apache.hc.core5.http.nio.HandlerFactory; 36 import org.apache.hc.core5.http.protocol.HttpContext; 37 38 /** 39 * This interface represents only the most basic contract for HTTP request 40 * execution. It imposes no restrictions or particular details on the request 41 * execution process and leaves the specifics of state management, 42 * authentication and redirect handling up to individual implementations. 43 * 44 * @since 4.0 45 */ 46 public interface HttpAsyncClient { 47 48 /** 49 * Initiates asynchronous HTTP request execution using the given context. 50 * <p> 51 * The request producer passed to this method will be used to generate 52 * a request message and stream out its content without buffering it 53 * in memory. The response consumer passed to this method will be used 54 * to process a response message without buffering its content in memory. 55 * <p> 56 * Please note it may be unsafe to interact with the context instance 57 * while the request is still being executed. 58 * 59 * @param <T> the result type of request execution. 60 * @param requestProducer request producer callback. 61 * @param responseConsumer response consumer callback. 62 * @param pushHandlerFactory the push handler factory. Optional and may be {@code null}. 63 * @param context HTTP context. Optional and may be {@code null}. 64 * @param callback future callback. Optional and may be {@code null}. 65 * @return future representing pending completion of the operation. 66 */ 67 <T> Future<T> execute( 68 AsyncRequestProducer requestProducer, 69 AsyncResponseConsumer<T> responseConsumer, 70 HandlerFactory<AsyncPushConsumer> pushHandlerFactory, 71 HttpContext context, 72 FutureCallback<T> callback); 73 74 }