org.apache.hc.client5.http.classic.methods

Class HttpUriRequestBase

java.lang.Object

org.apache.hc.core5.http.message.HeaderGroup

org.apache.hc.core5.http.message.BasicHttpRequest

org.apache.hc.core5.http.message.BasicClassicHttpRequest

org.apache.hc.client5.http.classic.methods.HttpUriRequestBase

All Implemented Interfaces:

Serializable, HttpUriRequest, Configurable, Cancellable, CancellableDependency, ClassicHttpRequest, HttpEntityContainer, HttpMessage, HttpRequest, MessageHeaders

Direct Known Subclasses:

HttpDelete, HttpGet, HttpHead, HttpOptions, HttpPatch, HttpPost, HttpPut, HttpTrace

public class HttpUriRequestBase
extends BasicClassicHttpRequest
implements HttpUriRequest, CancellableDependency

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HttpUriRequestBase(String method, URI requestUri)

Method Summary

Modifier and Type	Method and Description
void	abort() Aborts execution of the request.
boolean	cancel() Cancels the ongoing operation or process.
RequestConfig	getConfig() Returns actual request configuration.
boolean	isAborted() Tests if the request execution has been aborted.
boolean	isCancelled() Determines whether the process or operation has been cancelled.
void	reset() Resets internal state of the request making it reusable.
void	setConfig(RequestConfig requestConfig)
void	setDependency(Cancellable cancellable) Sets Cancellable dependency on another ongoing process or operation represented by Cancellable.
String	toString() Returns a string representation of the object.

Methods inherited from class org.apache.hc.core5.http.message.BasicClassicHttpRequest

getEntity, setEntity

Methods inherited from class org.apache.hc.core5.http.message.BasicHttpRequest

addHeader, getAuthority, getMethod, getPath, getRequestUri, getScheme, getUri, getVersion, setAuthority, setHeader, setPath, setScheme, setUri, setVersion

Methods inherited from class org.apache.hc.core5.http.message.HeaderGroup

addHeader, clear, containsHeader, countHeaders, getCondensedHeader, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator, removeHeader, removeHeaders, removeHeaders, setHeader, setHeaders

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hc.core5.http.HttpRequest

getAuthority, getMethod, getPath, getRequestUri, getScheme, getUri, setAuthority, setPath, setScheme, setUri

Methods inherited from interface org.apache.hc.core5.http.HttpMessage

addHeader, addHeader, getVersion, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setVersion

Methods inherited from interface org.apache.hc.core5.http.MessageHeaders

containsHeader, countHeaders, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator

Methods inherited from interface org.apache.hc.core5.http.HttpEntityContainer

getEntity, setEntity

Constructor Detail

HttpUriRequestBase

public HttpUriRequestBase(String method,
                          URI requestUri)

Method Detail

abort

public void abort()
           throws UnsupportedOperationException

Description copied from interface: HttpUriRequest

Aborts execution of the request.

Specified by:

abort in interface HttpUriRequest

Throws:

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

cancel

public boolean cancel()

Description copied from interface: Cancellable

Cancels the ongoing operation or process.

Specified by:

cancel in interface Cancellable

Returns:

true if the operation or process has been cancelled as a result of this method call or false if it has already been cancelled or not started.

getConfig

public RequestConfig getConfig()

Description copied from interface: Configurable

Returns actual request configuration.

Specified by:

getConfig in interface Configurable

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.

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableDependency

Determines whether the process or operation has been cancelled.

Specified by:

isCancelled in interface CancellableDependency

Returns:

cancelled flag.

reset

public void reset()

Resets internal state of the request making it reusable.

Since:

4.2

setConfig

public void setConfig(RequestConfig requestConfig)

setDependency

public void setDependency(Cancellable cancellable)

Description copied from interface: CancellableDependency

Sets Cancellable dependency on another ongoing process or operation represented by Cancellable.

Specified by:

setDependency in interface CancellableDependency

Since:

4.2

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class BasicHttpRequest

Returns:

a string representation of the object.