View Javadoc

1   /*
2    * $Header: $
3    * ====================================================================
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   * ====================================================================
21   *
22   * This software consists of voluntary contributions made by many
23   * individuals on behalf of the Apache Software Foundation.  For more
24   * information on the Apache Software Foundation, please see
25   * <http://www.apache.org/>.
26   *
27   */
28  
29  package org.apache.http;
30  
31  /**
32   * A request with an entity.
33   *
34   * @since 4.0
35   */
36  public interface HttpEntityEnclosingRequest extends HttpRequest {
37  
38      /**
39       * Tells if this request should use the expect-continue handshake.
40       * The expect continue handshake gives the server a chance to decide
41       * whether to accept the entity enclosing request before the possibly
42       * lengthy entity is sent across the wire.
43       * @return true if the expect continue handshake should be used, false if
44       * not.
45       */
46      boolean expectContinue();
47  
48      /**
49       * Associates the entity with this request.
50       *
51       * @param entity the entity to send.
52       */
53      void setEntity(HttpEntity entity);
54  
55      /**
56       * Returns the entity associated with this request.
57       *
58       * @return entity
59       */
60      HttpEntity getEntity();
61  
62  }