Package org.apache.http.client.methods

Class HttpRequestWrapper

java.lang.Object

org.apache.http.message.AbstractHttpMessage

org.apache.http.client.methods.HttpRequestWrapper

All Implemented Interfaces:

HttpUriRequest, HttpMessage, HttpRequest

public class HttpRequestWrapper
extends AbstractHttpMessage
implements HttpUriRequest

A wrapper class for HttpRequest that can be used to change properties of the current request without modifying the original object.

Since:

4.3

Method Summary

Modifier and Type	Method	Description
void	abort()	Aborts execution of the request.
java.lang.String	getMethod()	Returns the HTTP method this request uses, such as GET, PUT, POST, or other.
HttpRequest	getOriginal()
HttpParams	getParams()	Deprecated. (4.3) use RequestConfig.
ProtocolVersion	getProtocolVersion()	Returns the protocol version this message is compatible with.
RequestLine	getRequestLine()	Returns the request line of this request.
HttpHost	getTarget()
java.net.URI	getURI()	Returns the URI this request uses, such as http://example.org/path/to/file.
boolean	isAborted()	Tests if the request execution has been aborted.
void	setProtocolVersion(ProtocolVersion version)
void	setURI(java.net.URI uri)
java.lang.String	toString()
static HttpRequestWrapper	wrap(HttpRequest request)	Creates a mutable wrapper of the original request.
static HttpRequestWrapper	wrap(HttpRequest request, HttpHost target)	Creates a mutable wrapper of the original request.

Methods inherited from class org.apache.http.message.AbstractHttpMessage

addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.http.HttpMessage

addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Method Detail

getProtocolVersion

public ProtocolVersion getProtocolVersion()

Description copied from interface: HttpMessage

Returns the protocol version this message is compatible with.

Specified by:

getProtocolVersion in interface HttpMessage

setProtocolVersion

public void setProtocolVersion(ProtocolVersion version)

getURI

public java.net.URI getURI()

Description copied from interface: HttpUriRequest

Returns the URI this request uses, such as http://example.org/path/to/file.

Note that the URI may be absolute URI (as above) or may be a relative URI.

Implementations are encouraged to return the URI that was initially requested.

To find the final URI after any redirects have been processed, please see the section entitled HTTP execution context in the HttpClient Tutorial

Specified by:

getURI in interface HttpUriRequest

setURI

public void setURI(java.net.URI uri)

getMethod

public java.lang.String getMethod()

Description copied from interface: HttpUriRequest

Returns the HTTP method this request uses, such as GET, PUT, POST, or other.

Specified by:

getMethod in interface HttpUriRequest

abort

public void abort()
           throws java.lang.UnsupportedOperationException

Description copied from interface: HttpUriRequest

Aborts execution of the request.

Specified by:

abort in interface HttpUriRequest

Throws:

java.lang.UnsupportedOperationException - if the abort operation is not supported / cannot be implemented.

isAborted

public boolean isAborted()

Description copied from interface: HttpUriRequest

Tests if the request execution has been aborted.

Specified by:

isAborted in interface HttpUriRequest

Returns:

true if the request execution has been aborted, false otherwise.

getRequestLine

public RequestLine getRequestLine()

Description copied from interface: HttpRequest

Returns the request line of this request.

Specified by:

getRequestLine in interface HttpRequest

Returns:

the request line.

getOriginal

public HttpRequest getOriginal()

getTarget

public HttpHost getTarget()

Since:

4.4

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

wrap

public static HttpRequestWrapper wrap(HttpRequest request)

Creates a mutable wrapper of the original request.

Parameters:

request - original request

Returns:

mutable request wrappering the original one

wrap

public static HttpRequestWrapper wrap(HttpRequest request,
                                      HttpHost target)

Creates a mutable wrapper of the original request.

Parameters:

request - original request

target - original target, if explicitly specified

Returns:

mutable request wrappering the original one

Since:

4.4

getParams

@Deprecated
public HttpParams getParams()

Deprecated.

(4.3) use RequestConfig.

Description copied from interface: HttpMessage

Returns the parameters effective for this message as set by HttpMessage.setParams(HttpParams).

Specified by:

getParams in interface HttpMessage

Overrides:

getParams in class AbstractHttpMessage