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.http;
28  
29  /**
30   * A request with an entity.
31   *
32   * @since 4.0
33   */
34  public interface HttpEntityEnclosingRequest extends HttpRequest {
35  
36      /**
37       * Tells if this request should use the expect-continue handshake.
38       * The expect continue handshake gives the server a chance to decide
39       * whether to accept the entity enclosing request before the possibly
40       * lengthy entity is sent across the wire.
41       * @return true if the expect continue handshake should be used, false if
42       * not.
43       */
44      boolean expectContinue();
45  
46      /**
47       * Associates the entity with this request.
48       *
49       * @param entity the entity to send.
50       */
51      void setEntity(HttpEntity entity);
52  
53      /**
54       * Returns the entity associated with this request.
55       *
56       * @return entity
57       */
58      HttpEntity getEntity();
59  
60  }