View Javadoc
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.annotation.Contract;
32  import org.apache.hc.core5.annotation.ThreadingBehavior;
33  import org.apache.hc.core5.http.HttpException;
34  import org.apache.hc.core5.http.HttpRequest;
35  import org.apache.hc.core5.http.HttpResponse;
36  import org.apache.hc.core5.http.protocol.HttpContext;
37  
38  /**
39   * @since 5.0
40   */
41  @Contract(threading = ThreadingBehavior.STATELESS)
42  public interface AsyncServerRequestHandler<T> {
43  
44      interface ResponseTrigger {
45  
46          void sendInformation(HttpResponse response) throws HttpException, IOException;
47  
48          void submitResponse(AsyncResponseProducer responseProducer) throws HttpException, IOException;
49  
50          void pushPromise(HttpRequest promise, AsyncPushProducer responseProducer) throws HttpException, IOException;
51  
52      }
53  
54      AsyncRequestConsumer<T> prepare(HttpRequest request, HttpContext context) throws HttpException;
55  
56      void handle(T requestMessage, ResponseTrigger responseTrigger, HttpContext context) throws HttpException, IOException;
57  
58  }