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.io; 28 29 import java.io.IOException; 30 31 import org.apache.hc.core5.annotation.Contract; 32 import org.apache.hc.core5.annotation.ThreadingBehavior; 33 import org.apache.hc.core5.http.ClassicHttpRequest; 34 import org.apache.hc.core5.http.ClassicHttpResponse; 35 import org.apache.hc.core5.http.HttpException; 36 import org.apache.hc.core5.http.protocol.HttpContext; 37 38 /** 39 * HttpServerRequestHandler represents a routine for processing of a specific group 40 * of HTTP requests. Request execution filters are designed to take care of protocol 41 * specific aspects, whereas individual request handlers are expected to take 42 * care of application specific HTTP processing. The main purpose of a request 43 * handler is to generate a response object with a content entity to be sent 44 * back to the client in response to the given request. 45 * 46 * @since 5.0 47 */ 48 @Contract(threading = ThreadingBehavior.STATELESS) 49 public interface HttpServerRequestHandler { 50 51 /** 52 * Response trigger that can be used to submit a final HTTP response 53 * and terminate HTTP request processing. 54 */ 55 interface ResponseTrigger { 56 57 /** 58 * Sends an intermediate informational HTTP response to the client. 59 * 60 * @param response the intermediate (1xx) HTTP response 61 */ 62 void sendInformation(ClassicHttpResponse response) throws HttpException, IOException; 63 64 /** 65 * Sends a final HTTP response to the client. 66 * 67 * @param response the final (non 1xx) HTTP response 68 */ 69 void submitResponse(ClassicHttpResponse response) throws HttpException, IOException; 70 71 } 72 73 /** 74 * Handles the request and submits a final response to be sent back to the client. 75 * 76 * @param request the actual request. 77 * @param responseTrigger the response trigger. 78 * @param context the actual execution context. 79 */ 80 void handle( 81 ClassicHttpRequest request, 82 ResponseTrigger responseTrigger, 83 HttpContext context) throws HttpException, IOException; 84 85 }