001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027package org.apache.http;
028
029/**
030 * A request with an entity.
031 *
032 * @since 4.0
033 */
034public interface HttpEntityEnclosingRequest extends HttpRequest {
035
036    /**
037     * Tells if this request should use the expect-continue handshake.
038     * The expect continue handshake gives the server a chance to decide
039     * whether to accept the entity enclosing request before the possibly
040     * lengthy entity is sent across the wire.
041     * @return true if the expect continue handshake should be used, false if
042     * not.
043     */
044    boolean expectContinue();
045
046    /**
047     * Associates the entity with this request.
048     *
049     * @param entity the entity to send.
050     */
051    void setEntity(HttpEntity entity);
052
053    /**
054     * Returns the entity associated with this request.
055     *
056     * @return entity
057     */
058    HttpEntity getEntity();
059
060}