Top Description Fields Constructors Methods
org.apache.http.client.methods

public abstract Class HttpEntityEnclosingRequestBase

extends HttpRequestBase
implements HttpEntityEnclosingRequest
Class Inheritance
All Implemented Interfaces
org.apache.http.HttpEntityEnclosingRequest, org.apache.http.HttpRequest, org.apache.http.HttpMessage
Known Direct Subclasses
org.apache.http.client.methods.HttpPatch, org.apache.http.client.methods.HttpPost, org.apache.http.client.methods.HttpPut, org.apache.http.client.methods.RequestBuilder.InternalEntityEclosingRequest
Imports
org.apache.http.Header, .HttpEntity, .HttpEntityEnclosingRequest, org.apache.http.client.utils.CloneUtils, org.apache.http.protocol.HTTP

Deprecated

as a consequence of HttpRequestBase being deprecated. See corresponding docs for further information.

Basic implementation of an entity enclosing HTTP request that can be modified
Since
4.0

Field Summary

Modifier and TypeField and Description
private HttpEntity

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides org.apache.http.client.methods.AbstractExecutionAwareRequest.clone.

Creates and returns a copy of this object.
public boolean
expectContinue()

Implements org.apache.http.HttpEntityEnclosingRequest.expectContinue.

Tells if this request should use the expect-continue handshake.
public HttpEntity
getEntity()

Implements org.apache.http.HttpEntityEnclosingRequest.getEntity.

Returns the entity associated with this request.
public void
setEntity(final HttpEntity
the entity to send.
entity
)

Implements org.apache.http.HttpEntityEnclosingRequest.setEntity.

Associates the entity with this request.
Inherited from org.apache.http.client.methods.HttpRequestBase:
getConfiggetMethodgetProtocolVersiongetRequestLinegetURIreleaseConnectionsetConfigsetProtocolVersionsetURIstartedtoString

Field Detail

entityback to summary
private HttpEntity entity

Constructor Detail

HttpEntityEnclosingRequestBaseback to summary
public HttpEntityEnclosingRequestBase()

Method Detail

cloneback to summary
public Object clone() throws CloneNotSupportedException

Overrides org.apache.http.client.methods.AbstractExecutionAwareRequest.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations
@Override
Exceptions
CloneNotSupportedException:
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.
expectContinueback to summary
public boolean expectContinue()

Implements org.apache.http.HttpEntityEnclosingRequest.expectContinue.

Doc from org.apache.http.HttpEntityEnclosingRequest.expectContinue.

Tells if this request should use the expect-continue handshake. The expect continue handshake gives the server a chance to decide whether to accept the entity enclosing request before the possibly lengthy entity is sent across the wire.

Returns:boolean

true if the expect continue handshake should be used, false if not.

Annotations
@Override
getEntityback to summary
public HttpEntity getEntity()

Implements org.apache.http.HttpEntityEnclosingRequest.getEntity.

Doc from org.apache.http.HttpEntityEnclosingRequest.getEntity.

Returns the entity associated with this request.

Returns:HttpEntity

entity

Annotations
@Override
setEntityback to summary
public void setEntity(final HttpEntity entity)

Implements org.apache.http.HttpEntityEnclosingRequest.setEntity.

Doc from org.apache.http.HttpEntityEnclosingRequest.setEntity.

Associates the entity with this request.

Parameters
entity:HttpEntity

the entity to send.

Annotations
@Override