Home How it Works Android APIMiner IDE Version More Info

to top

Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

RequestWrapper

extends AbstractHttpMessage
implements HttpUriRequest

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

Known Direct Subclasses

EntityEnclosingRequestWrapper

Class Overview

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.

Summary

[Expand]

Inherited Fields

From class org.apache.http.message.AbstractHttpMessage

Public Constructors
	RequestWrapper( HttpRequest request)

Public Methods
void	abort() Aborts execution of the request.
int	getExecCount()
String	getMethod() Returns the HTTP method this request uses, such as `GET`, `PUT`, `POST`, or other.
HttpRequest	getOriginal()
ProtocolVersion	getProtocolVersion() Returns the protocol version this message is compatible with.
RequestLine	getRequestLine() Returns the request line of this request.
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( String method)
void	setProtocolVersion( ProtocolVersion version)
void	setURI( URI uri)

[Expand]

Inherited Methods

From class org.apache.http.message.AbstractHttpMessage

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface org.apache.http.HttpMessage

abstract void	addHeader( Header header) Adds a header to this message.
abstract void	addHeader( String name, String value) Adds a header to this message.
abstract boolean	containsHeader( String name) Checks if a certain header is present in this message.
abstract Header[]	getAllHeaders() Returns all the headers of this message.
abstract Header	getFirstHeader( String name) Returns the first header with a specified name of this message.
abstract Header[]	getHeaders( String name) Returns all the headers with a specified name of this message.
abstract Header	getLastHeader( String name) Returns the last header with a specified name of this message.
abstract HttpParams	getParams() Returns the parameters effective for this message as set by `setParams(HttpParams)`.
abstract ProtocolVersion	getProtocolVersion() Returns the protocol version this message is compatible with.
abstract HeaderIterator	headerIterator( String name) Returns an iterator of the headers with a given name.
abstract HeaderIterator	headerIterator() Returns an iterator of all the headers.
abstract void	removeHeader( Header header) Removes a header from this message.
abstract void	removeHeaders( String name) Removes all headers with a certain name from this message.
abstract void	setHeader( Header header) Overwrites the first header with the same name.
abstract void	setHeader( String name, String value) Overwrites the first header with the same name.
abstract void	setHeaders( Header[] headers) Overwrites all the headers in the message.
abstract void	setParams( HttpParams params) Provides parameters to be used for the processing of this message.

From interface org.apache.http.HttpRequest

From interface org.apache.http.client.methods.HttpUriRequest

Public Constructors

public RequestWrapper (HttpRequest request)

Added in API level 1

Throws

ProtocolException

Public Methods

public void abort ()

Added in API level 1

Aborts execution of the request.

Throws

UnsupportedOperationException

public int getExecCount ()

Added in API level 1

public String getMethod ()

Added in API level 1

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

public HttpRequest getOriginal ()

Added in API level 1

public ProtocolVersion getProtocolVersion ()

Added in API level 1

Returns the protocol version this message is compatible with.

public RequestLine getRequestLine ()

Added in API level 1

Returns the request line of this request.

Returns

the request line.

public URI getURI ()

Added in API level 1

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

public void incrementExecCount ()

Added in API level 1

public boolean isAborted ()

Added in API level 1

Tests if the request execution has been aborted.

Returns

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

public boolean isRepeatable ()

Added in API level 1

public void resetHeaders ()

Added in API level 1

public void setMethod (String method)

Added in API level 1

public void setProtocolVersion (ProtocolVersion version)

Added in API level 1

public void setURI (URI uri)

Added in API level 1

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Classes

Exceptions

RequestWrapper

Class Overview

Summary

Public Constructors

public RequestWrapper (HttpRequest request)

Throws

Public Methods

public void abort ()

Throws

public int getExecCount ()

public String getMethod ()

public HttpRequest getOriginal ()

public ProtocolVersion getProtocolVersion ()

public RequestLine getRequestLine ()

Returns

public URI getURI ()

public void incrementExecCount ()

public boolean isAborted ()

Returns

public boolean isRepeatable ()

public void resetHeaders ()

public void setMethod (String method)

public void setProtocolVersion (ProtocolVersion version)

public void setURI (URI uri)