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.io.IOException;
30
31 import org.apache.hc.core5.http.EntityDetails;
32 import org.apache.hc.core5.http.HttpException;
33 import org.apache.hc.core5.http.HttpResponse;
34 import org.apache.hc.core5.http.nio.AsyncDataConsumer;
35
36 /**
37 * AsyncExecCallback methods represent response processing events
38 * in the client side request execution chain.
39 *
40 * @since 5.0
41 */
42 public interface AsyncExecCallback {
43
44 /**
45 * Triggered to signal receipt of a response message head sent by the server
46 * in response to the request being executed.
47 *
48 * @param response the response message head.
49 * @param entityDetails the response entity details or {@code null} if the response
50 * does not enclose an entity.
51 * @return the data consumer to be used for processing of incoming response message body.
52 */
53 AsyncDataConsumer handleResponse(
54 HttpResponse response,
55 EntityDetails entityDetails) throws HttpException, IOException;
56
57 /**
58 * Triggered to signal receipt of an intermediate response message.
59 *
60 * @param response the intermediate response message.
61 */
62 void handleInformationResponse(HttpResponse response) throws HttpException, IOException;
63
64 /**
65 * Triggered to signal completion of the message exchange.
66 * <p>
67 * Implementations of this message are expected to perform resource deallocation
68 * allocated in the course of the request execution and response processing.
69 * </p>
70 */
71 void completed();
72
73 /**
74 * Triggered to signal a failure occurred during the message exchange.
75 * <p>
76 * Implementations of this message are expected to perform resource deallocation
77 * allocated in the course of the request execution and response processing.
78 * </p>
79 */
80 void failed(Exception cause);
81
82 }