org.apache.http.impl.client
Class RequestWrapper

java.lang.Object
  org.apache.http.message.AbstractHttpMessage
      org.apache.http.impl.client.RequestWrapper

All Implemented Interfaces:

HttpUriRequest, org.apache.http.HttpMessage, org.apache.http.HttpRequest

Direct Known Subclasses:

EntityEnclosingRequestWrapper

@NotThreadSafe
public class RequestWrapper
extends org.apache.http.message.AbstractHttpMessage
implements HttpUriRequest

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

This class is also capable of resetting the request headers to the state of the original request.

Since:

4.0

Field Summary

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

headergroup, params

Constructor Summary

RequestWrapper(org.apache.http.HttpRequest request)

Method Summary

void	abort() Aborts execution of the request.
int	getExecCount()
java.lang.String	getMethod() Returns the HTTP method this request uses, such as GET, PUT, POST, or other.
org.apache.http.HttpRequest	getOriginal()
org.apache.http.ProtocolVersion	getProtocolVersion()
org.apache.http.RequestLine	getRequestLine()
java.net.URI	getURI() Returns the URI this request uses, such as http://example.org/path/to/file.
void	incrementExecCount()
boolean	isAborted() Tests if the request execution has been aborted.
boolean	isRepeatable()
void	resetHeaders()
void	setMethod(java.lang.String method)
void	setProtocolVersion(org.apache.http.ProtocolVersion version)
void	setURI(java.net.URI uri)

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.http.HttpMessage

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

Constructor Detail

RequestWrapper

public RequestWrapper(org.apache.http.HttpRequest request)
               throws org.apache.http.ProtocolException

Throws:

org.apache.http.ProtocolException

Method Detail

resetHeaders

public void resetHeaders()

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

setMethod

public void setMethod(java.lang.String method)

getProtocolVersion

public org.apache.http.ProtocolVersion getProtocolVersion()

Specified by:

getProtocolVersion in interface org.apache.http.HttpMessage

setProtocolVersion

public void setProtocolVersion(org.apache.http.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)

getRequestLine

public org.apache.http.RequestLine getRequestLine()

Specified by:

getRequestLine in interface org.apache.http.HttpRequest

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.

getOriginal

public org.apache.http.HttpRequest getOriginal()

isRepeatable

public boolean isRepeatable()

getExecCount

public int getExecCount()

incrementExecCount

public void incrementExecCount()