1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/protocol/HttpExpectationVerifier.java Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,81 @@
1.4 +/*
1.5 + * ====================================================================
1.6 + * Licensed to the Apache Software Foundation (ASF) under one
1.7 + * or more contributor license agreements. See the NOTICE file
1.8 + * distributed with this work for additional information
1.9 + * regarding copyright ownership. The ASF licenses this file
1.10 + * to you under the Apache License, Version 2.0 (the
1.11 + * "License"); you may not use this file except in compliance
1.12 + * with the License. You may obtain a copy of the License at
1.13 + *
1.14 + * http://www.apache.org/licenses/LICENSE-2.0
1.15 + *
1.16 + * Unless required by applicable law or agreed to in writing,
1.17 + * software distributed under the License is distributed on an
1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
1.19 + * KIND, either express or implied. See the License for the
1.20 + * specific language governing permissions and limitations
1.21 + * under the License.
1.22 + * ====================================================================
1.23 + *
1.24 + * This software consists of voluntary contributions made by many
1.25 + * individuals on behalf of the Apache Software Foundation. For more
1.26 + * information on the Apache Software Foundation, please see
1.27 + * <http://www.apache.org/>.
1.28 + *
1.29 + */
1.30 +
1.31 +package ch.boye.httpclientandroidlib.protocol;
1.32 +
1.33 +import ch.boye.httpclientandroidlib.HttpException;
1.34 +import ch.boye.httpclientandroidlib.HttpRequest;
1.35 +import ch.boye.httpclientandroidlib.HttpResponse;
1.36 +
1.37 +/**
1.38 + * Defines an interface to verify whether an incoming HTTP request meets
1.39 + * the target server's expectations.
1.40 + *<p>
1.41 + * The Expect request-header field is used to indicate that particular
1.42 + * server behaviors are required by the client.
1.43 + *</p>
1.44 + *<pre>
1.45 + * Expect = "Expect" ":" 1#expectation
1.46 + *
1.47 + * expectation = "100-continue" | expectation-extension
1.48 + * expectation-extension = token [ "=" ( token | quoted-string )
1.49 + * *expect-params ]
1.50 + * expect-params = ";" token [ "=" ( token | quoted-string ) ]
1.51 + *</pre>
1.52 + *<p>
1.53 + * A server that does not understand or is unable to comply with any of
1.54 + * the expectation values in the Expect field of a request MUST respond
1.55 + * with appropriate error status. The server MUST respond with a 417
1.56 + * (Expectation Failed) status if any of the expectations cannot be met
1.57 + * or, if there are other problems with the request, some other 4xx
1.58 + * status.
1.59 + *</p>
1.60 + *
1.61 + * @since 4.0
1.62 + */
1.63 +public interface HttpExpectationVerifier {
1.64 +
1.65 + /**
1.66 + * Verifies whether the given request meets the server's expectations.
1.67 + * <p>
1.68 + * If the request fails to meet particular criteria, this method can
1.69 + * trigger a terminal response back to the client by setting the status
1.70 + * code of the response object to a value greater or equal to
1.71 + * <code>200</code>. In this case the client will not have to transmit
1.72 + * the request body. If the request meets expectations this method can
1.73 + * terminate without modifying the response object. Per default the status
1.74 + * code of the response object will be set to <code>100</code>.
1.75 + *
1.76 + * @param request the HTTP request.
1.77 + * @param response the HTTP response.
1.78 + * @param context the HTTP context.
1.79 + * @throws HttpException in case of an HTTP protocol violation.
1.80 + */
1.81 + void verify(HttpRequest request, HttpResponse response, HttpContext context)
1.82 + throws HttpException;
1.83 +
1.84 +}
