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

public abstract class

HttpRequestBase

extends AbstractHttpMessage
implements Cloneable AbortableHttpRequest HttpUriRequest

java.lang.Object
↳	org.apache.http.message.AbstractHttpMessage
	↳	org.apache.http.client.methods.HttpRequestBase

Known Direct Subclasses

HttpDelete, HttpEntityEnclosingRequestBase, HttpGet, HttpHead, HttpOptions, HttpTrace

Known Indirect Subclasses

HttpPost, HttpPut

Class Overview

Basic implementation of an HTTP request that can be modified.

Summary

[Expand]

Inherited Fields

From class org.apache.http.message.AbstractHttpMessage

Public Constructors
	HttpRequestBase()

Public Methods
void	abort() Aborts this http request.
Object	clone() Creates and returns a copy of this `Object`.
abstract String	getMethod() Returns the HTTP method this request uses, such as `GET`, `PUT`, `POST`, or other.
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`.
boolean	isAborted() Tests if the request execution has been aborted.
void	setConnectionRequest(ClientConnectionRequest connRequest) Sets the `ClientConnectionRequest` callback that can be used to abort a long-lived request for a connection.
void	setReleaseTrigger(ConnectionReleaseTrigger releaseTrigger) Sets the `ConnectionReleaseTrigger` callback that can be used to abort an active connection.
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() Called before the object's memory is reclaimed by the VM.
final Class<? extends Object>	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.AbortableHttpRequest

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

Public Constructors

public HttpRequestBase ()

Since: API Level 1

Public Methods

public void abort ()

Since: API Level 1

Aborts this http request. Any active execution of this method should return immediately. If the request has not started, it will abort after the next execution. Aborting this request will cause all subsequent executions with this request to fail.

public Object clone ()

Since: API Level 1

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns

a copy of this object.

Throws

CloneNotSupportedException

public abstract String getMethod ()

Since: API Level 1

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

public ProtocolVersion getProtocolVersion ()

Since: API Level 1

Returns the protocol version this message is compatible with.

public RequestLine getRequestLine ()

Since: API Level 1

Returns the request line of this request.

Returns

the request line.

public URI getURI ()

Since: API Level 1

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

public boolean isAborted ()

Since: API Level 1

Tests if the request execution has been aborted.

Returns

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

public void setConnectionRequest (ClientConnectionRequest connRequest)

Since: API Level 1

Sets the ClientConnectionRequest callback that can be used to abort a long-lived request for a connection. If the request is already aborted, throws an IOException.

Throws

IOException

public void setReleaseTrigger (ConnectionReleaseTrigger releaseTrigger)

Since: API Level 1

Sets the ConnectionReleaseTrigger callback that can be used to abort an active connection. Typically, this will be the ManagedClientConnection itself. If the request is already aborted, throws an IOException.

Throws

IOException

public void setURI (URI uri)

Since: API Level 1

Interfaces

Classes

HttpRequestBase

Class Overview

Summary

Public Constructors

public HttpRequestBase ()

Public Methods

public void abort ()

public Object clone ()

Returns

Throws

public abstract String getMethod ()

public ProtocolVersion getProtocolVersion ()

public RequestLine getRequestLine ()

Returns

public URI getURI ()

public boolean isAborted ()

Returns

public void setConnectionRequest (ClientConnectionRequest connRequest)

Throws

public void setReleaseTrigger (ConnectionReleaseTrigger releaseTrigger)

Throws

public void setURI (URI uri)