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.core5.http.nio; 28 29 import java.io.IOException; 30 31 import org.apache.hc.core5.concurrent.FutureCallback; 32 import org.apache.hc.core5.http.EntityDetails; 33 import org.apache.hc.core5.http.HttpException; 34 import org.apache.hc.core5.http.HttpResponse; 35 import org.apache.hc.core5.http.protocol.HttpContext; 36 37 /** 38 * Abstract asynchronous response consumer. 39 * 40 * @param <T> response representation. 41 * 42 * @since 5.0 43 */ 44 public interface AsyncResponseConsumer<T> extends AsyncDataConsumer { 45 46 /** 47 * Triggered to signal receipt of a response message head. 48 * 49 * @param response the response message head. 50 * @param entityDetails the response entity details or {@code null} if the response 51 * does not enclose an entity. 52 * @param context the actual execution context. 53 * @param resultCallback the result callback called when response processing 54 * has been completed successfully or unsuccessfully. 55 */ 56 void consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext context, 57 FutureCallback<T> resultCallback) throws HttpException, IOException; 58 59 /** 60 * Triggered to signal receipt of an intermediate (1xx) HTTP response. 61 * 62 * @param response the intermediate (1xx) HTTP response. 63 * @param context the actual execution context. 64 */ 65 void informationResponse(HttpResponse response, HttpContext context) throws HttpException, IOException; 66 67 /** 68 * Triggered to signal a failure in data processing. 69 * 70 * @param cause the cause of the failure. 71 */ 72 void failed(Exception cause); 73 74 }