Top Fields Constructors Methods
org.apache.hc.client5.http.classic.methods

public Class HttpUriRequestBase

extends BasicClassicHttpRequest
implements HttpUriRequest, CancellableDependency
Class Inheritance
All Implemented Interfaces
org.apache.hc.core5.concurrent.CancellableDependency, org.apache.hc.core5.concurrent.Cancellable, org.apache.hc.client5.http.classic.methods.HttpUriRequest, org.apache.hc.client5.http.config.Configurable, org.apache.hc.core5.http.ClassicHttpRequest, org.apache.hc.core5.http.HttpEntityContainer, org.apache.hc.core5.http.HttpRequest, org.apache.hc.core5.http.HttpMessage, org.apache.hc.core5.http.MessageHeaders
Known Direct Subclasses
org.apache.hc.client5.http.classic.methods.HttpDelete, org.apache.hc.client5.http.classic.methods.HttpGet, org.apache.hc.client5.http.classic.methods.HttpHead, org.apache.hc.client5.http.classic.methods.HttpOptions, org.apache.hc.client5.http.classic.methods.HttpPatch, org.apache.hc.client5.http.classic.methods.HttpPost, org.apache.hc.client5.http.classic.methods.HttpPut, org.apache.hc.client5.http.classic.methods.HttpTrace
Imports
java.net.URI, java.util.concurrent.atomic.AtomicMarkableReference, org.apache.hc.client5.http.config.RequestConfig, org.apache.hc.core5.concurrent.Cancellable, .CancellableDependency, org.apache.hc.core5.http.message.BasicClassicHttpRequest

Field Summary

Modifier and TypeField and Description
private final AtomicMarkableReference<Cancellable>
cancellableRef

private RequestConfig
requestConfig

private static final long
serialVersionUID

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

Constructor Summary

AccessConstructor and Description
public
HttpUriRequestBase(final String method, final URI requestUri)

Method Summary

Modifier and TypeMethod and Description
public void
abort()

Implements org.apache.hc.client5.http.classic.methods.HttpUriRequest.abort.

Aborts execution of the request.
public boolean
cancel()

Implements org.apache.hc.core5.concurrent.Cancellable.cancel.

Cancels the ongoing operation or process.
public RequestConfig
getConfig()

Implements org.apache.hc.client5.http.config.Configurable.getConfig.

Returns actual request configuration.
public boolean
isAborted()

Implements org.apache.hc.client5.http.classic.methods.HttpUriRequest.isAborted.

Tests if the request execution has been aborted.
public boolean
isCancelled()

Implements org.apache.hc.core5.concurrent.CancellableDependency.isCancelled.

Determines whether the process or operation has been cancelled.
public void
reset()

Resets internal state of the request making it reusable.

public void
setConfig(final RequestConfig requestConfig)

public void
setDependency(final Cancellable cancellable)

Implements org.apache.hc.core5.concurrent.CancellableDependency.setDependency.

Sets Cancellable dependency on another ongoing process or operation represented by Cancellable.
public String
toString()

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

Returns a string representation of the object.
Inherited from org.apache.hc.core5.http.message.BasicClassicHttpRequest:
getEntitysetEntity

Field Detail

cancellableRefback to summary
private final AtomicMarkableReference<Cancellable> cancellableRef
requestConfigback to summary
private RequestConfig requestConfig
serialVersionUIDback to summary
private static final long serialVersionUID

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

Constructor Detail

HttpUriRequestBaseback to summary
public HttpUriRequestBase(final String method, final URI requestUri)

Method Detail

abortback to summary
public void abort() throws UnsupportedOperationException

Implements org.apache.hc.client5.http.classic.methods.HttpUriRequest.abort.

Doc from org.apache.hc.client5.http.classic.methods.HttpUriRequest.abort.

Aborts execution of the request.

Annotations
@Override
Exceptions
UnsupportedOperationException:
if the abort operation is not supported / cannot be implemented.
cancelback to summary
public boolean cancel()

Implements org.apache.hc.core5.concurrent.Cancellable.cancel.

Doc from org.apache.hc.core5.concurrent.Cancellable.cancel.

Cancels the ongoing operation or process.

Returns:boolean

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.

Annotations
@Override
getConfigback to summary
public RequestConfig getConfig()

Implements org.apache.hc.client5.http.config.Configurable.getConfig.

Doc from org.apache.hc.client5.http.config.Configurable.getConfig.

Returns actual request configuration.

Annotations
@Override
isAbortedback to summary
public boolean isAborted()

Implements org.apache.hc.client5.http.classic.methods.HttpUriRequest.isAborted.

Doc from org.apache.hc.client5.http.classic.methods.HttpUriRequest.isAborted.

Tests if the request execution has been aborted.

Returns:boolean

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

Annotations
@Override
isCancelledback to summary
public boolean isCancelled()

Implements org.apache.hc.core5.concurrent.CancellableDependency.isCancelled.

Doc from org.apache.hc.core5.concurrent.CancellableDependency.isCancelled.

Determines whether the process or operation has been cancelled.

Returns:boolean

cancelled flag.

Annotations
@Override
resetback to summary
public void reset()

Resets internal state of the request making it reusable.

Since
4.2
setConfigback to summary
public void setConfig(final RequestConfig requestConfig)
setDependencyback to summary
public void setDependency(final Cancellable cancellable)

Implements org.apache.hc.core5.concurrent.CancellableDependency.setDependency.

Doc from org.apache.hc.core5.concurrent.CancellableDependency.setDependency.

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

Annotations
@Override
Since
4.2
toStringback to summary
public String toString()

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

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override