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.support;
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.EntityDetails;
34  import org.apache.hc.core5.http.HttpException;
35  import org.apache.hc.core5.http.HttpRequest;
36  import org.apache.hc.core5.http.HttpResponse;
37  import org.apache.hc.core5.http.HttpStatus;
38  import org.apache.hc.core5.http.message.BasicHttpResponse;
39  import org.apache.hc.core5.http.nio.AsyncDataConsumer;
40  import org.apache.hc.core5.http.nio.AsyncEntityProducer;
41  import org.apache.hc.core5.http.nio.AsyncFilterChain;
42  import org.apache.hc.core5.http.nio.AsyncFilterHandler;
43  import org.apache.hc.core5.http.support.ExpectSupport;
44  import org.apache.hc.core5.http.support.Expectation;
45  import org.apache.hc.core5.http.protocol.HttpContext;
46  
47  /**
48   * @since 5.0
49   */
50  @Contract(threading = ThreadingBehavior.STATELESS)
51  public class AsyncServerExpectationFilter implements AsyncFilterHandler {
52  
53      protected boolean verify(final HttpRequest request, final HttpContext context) throws HttpException {
54          return true;
55      }
56  
57      protected AsyncEntityProducer generateResponseContent(final HttpResponse expectationFailed) throws HttpException {
58          return null;
59      }
60  
61      @Override
62      public final AsyncDataConsumer handle(
63              final HttpRequest request,
64              final EntityDetails entityDetails,
65              final HttpContext context,
66              final AsyncFilterChain.ResponseTrigger responseTrigger,
67              final AsyncFilterChain chain) throws HttpException, IOException {
68          final Expectation expectation = ExpectSupport.parse(request, entityDetails);
69          if (expectation == Expectation.CONTINUE) {
70              final boolean verified = verify(request, context);
71              if (verified) {
72                  responseTrigger.sendInformation(new BasicHttpResponse(HttpStatus.SC_CONTINUE));
73              } else {
74                  final HttpResponse expectationFailed = new BasicHttpResponse(HttpStatus.SC_EXPECTATION_FAILED);
75                  final AsyncEntityProducer responseContentProducer = generateResponseContent(expectationFailed);
76                  responseTrigger.submitResponse(expectationFailed, responseContentProducer);
77                  return null;
78              }
79          } else if (expectation == Expectation.UNKNOWN) {
80              final HttpResponse expectationFailed = new BasicHttpResponse(HttpStatus.SC_EXPECTATION_FAILED);
81              final AsyncEntityProducer responseContentProducer = generateResponseContent(expectationFailed);
82              responseTrigger.submitResponse(expectationFailed, responseContentProducer);
83              return null;
84          }
85          return chain.proceed(request, entityDetails, context, responseTrigger);
86      }
87  
88  }