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 28 package org.apache.hc.core5.http.nio; 29 30 import java.io.IOException; 31 32 import org.apache.hc.core5.annotation.Contract; 33 import org.apache.hc.core5.annotation.ThreadingBehavior; 34 import org.apache.hc.core5.http.EntityDetails; 35 import org.apache.hc.core5.http.HttpException; 36 import org.apache.hc.core5.http.HttpRequest; 37 import org.apache.hc.core5.http.HttpResponse; 38 import org.apache.hc.core5.http.protocol.HttpContext; 39 40 /** 41 * Abstract response / response promise channel. 42 * <p> 43 * Implementations are expected to be thread-safe. 44 * </p> 45 * 46 * @since 5.0 47 */ 48 @Contract(threading = ThreadingBehavior.SAFE) 49 public interface ResponseChannel { 50 51 /** 52 * Sends an intermediate informational HTTP response through this channel. 53 * 54 * @param response an intermediate (1xx) HTTP response. 55 * @param context the actual execution context. 56 */ 57 void sendInformation(HttpResponse response, HttpContext context) throws HttpException, IOException; 58 59 /** 60 * Sends a final HTTP response through this channel. 61 * 62 * @param response a final (non 1xx) HTTP response 63 * @param entityDetails the response entity details or {@code null} if the response 64 * does not enclose an entity. 65 * @param context the actual execution context. 66 */ 67 void sendResponse(HttpResponse response, EntityDetails entityDetails, HttpContext context) throws HttpException, IOException; 68 69 /** 70 * Pushes a request message head through this channel as a promise to deliver 71 * a response message. 72 * 73 * @param promise the request message header used as a promise. 74 * @param responseProducer the push response message producer. 75 * @param context the actual execution context. 76 */ 77 void pushPromise(HttpRequest promise, AsyncPushProducer responseProducer, HttpContext context) throws HttpException, IOException; 78 79 }