mobile/android/thirdparty/ch/boye/httpclientandroidlib/protocol/HttpExpectationVerifier.java

Wed, 31 Dec 2014 07:22:50 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 07:22:50 +0100
branch
TOR_BUG_3246
changeset 4
fc2d59ddac77
permissions
-rw-r--r--

Correct previous dual key logic pending first delivery installment.

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 * Licensed to the Apache Software Foundation (ASF) under one
michael@0 4 * or more contributor license agreements. See the NOTICE file
michael@0 5 * distributed with this work for additional information
michael@0 6 * regarding copyright ownership. The ASF licenses this file
michael@0 7 * to you under the Apache License, Version 2.0 (the
michael@0 8 * "License"); you may not use this file except in compliance
michael@0 9 * with the License. You may obtain a copy of the License at
michael@0 10 *
michael@0 11 * http://www.apache.org/licenses/LICENSE-2.0
michael@0 12 *
michael@0 13 * Unless required by applicable law or agreed to in writing,
michael@0 14 * software distributed under the License is distributed on an
michael@0 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0 16 * KIND, either express or implied. See the License for the
michael@0 17 * specific language governing permissions and limitations
michael@0 18 * under the License.
michael@0 19 * ====================================================================
michael@0 20 *
michael@0 21 * This software consists of voluntary contributions made by many
michael@0 22 * individuals on behalf of the Apache Software Foundation. For more
michael@0 23 * information on the Apache Software Foundation, please see
michael@0 24 * <http://www.apache.org/>.
michael@0 25 *
michael@0 26 */
michael@0 27
michael@0 28 package ch.boye.httpclientandroidlib.protocol;
michael@0 29
michael@0 30 import ch.boye.httpclientandroidlib.HttpException;
michael@0 31 import ch.boye.httpclientandroidlib.HttpRequest;
michael@0 32 import ch.boye.httpclientandroidlib.HttpResponse;
michael@0 33
michael@0 34 /**
michael@0 35 * Defines an interface to verify whether an incoming HTTP request meets
michael@0 36 * the target server's expectations.
michael@0 37 *<p>
michael@0 38 * The Expect request-header field is used to indicate that particular
michael@0 39 * server behaviors are required by the client.
michael@0 40 *</p>
michael@0 41 *<pre>
michael@0 42 * Expect = "Expect" ":" 1#expectation
michael@0 43 *
michael@0 44 * expectation = "100-continue" | expectation-extension
michael@0 45 * expectation-extension = token [ "=" ( token | quoted-string )
michael@0 46 * *expect-params ]
michael@0 47 * expect-params = ";" token [ "=" ( token | quoted-string ) ]
michael@0 48 *</pre>
michael@0 49 *<p>
michael@0 50 * A server that does not understand or is unable to comply with any of
michael@0 51 * the expectation values in the Expect field of a request MUST respond
michael@0 52 * with appropriate error status. The server MUST respond with a 417
michael@0 53 * (Expectation Failed) status if any of the expectations cannot be met
michael@0 54 * or, if there are other problems with the request, some other 4xx
michael@0 55 * status.
michael@0 56 *</p>
michael@0 57 *
michael@0 58 * @since 4.0
michael@0 59 */
michael@0 60 public interface HttpExpectationVerifier {
michael@0 61
michael@0 62 /**
michael@0 63 * Verifies whether the given request meets the server's expectations.
michael@0 64 * <p>
michael@0 65 * If the request fails to meet particular criteria, this method can
michael@0 66 * trigger a terminal response back to the client by setting the status
michael@0 67 * code of the response object to a value greater or equal to
michael@0 68 * <code>200</code>. In this case the client will not have to transmit
michael@0 69 * the request body. If the request meets expectations this method can
michael@0 70 * terminate without modifying the response object. Per default the status
michael@0 71 * code of the response object will be set to <code>100</code>.
michael@0 72 *
michael@0 73 * @param request the HTTP request.
michael@0 74 * @param response the HTTP response.
michael@0 75 * @param context the HTTP context.
michael@0 76 * @throws HttpException in case of an HTTP protocol violation.
michael@0 77 */
michael@0 78 void verify(HttpRequest request, HttpResponse response, HttpContext context)
michael@0 79 throws HttpException;
michael@0 80
michael@0 81 }

mercurial