Top Description Fields Constructors Methods
org.apache.hc.core5.http.message

public Class BasicHttpRequest

extends HeaderGroup
implements HttpRequest
Class Inheritance
All Implemented Interfaces
org.apache.hc.core5.http.HttpRequest, org.apache.hc.core5.http.HttpMessage, org.apache.hc.core5.http.MessageHeaders
Known Direct Subclasses
org.apache.hc.core5.http.message.BasicClassicHttpRequest
Imports
java.net.URI, .URISyntaxException, org.apache.hc.core5.http.HttpHost, .HttpRequest, .Method, .ProtocolVersion, .URIScheme, org.apache.hc.core5.net.URIAuthority, org.apache.hc.core5.util.Args, .TextUtils
Basic implementation of HttpRequest.
Since
4.0

Field Summary

Modifier and TypeField and Description
private boolean
absoluteRequestUri

private URIAuthority
authority

private final String
method

private String
path

private URI
requestUri

private String
scheme

private static final long
serialVersionUID

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

private ProtocolVersion
version

Constructor Summary

AccessConstructor and Description
public
BasicHttpRequest(final String
request method.
method, final String
request scheme.
scheme, final URIAuthority
request authority.
authority, final String
request path.
path)

Creates request message with the given method, host and request path.

public
BasicHttpRequest(final String
request method.
method, final String
request path.
path)

Creates request message with the given method and request path.

public
BasicHttpRequest(final String
request method.
method, final HttpHost
request host.
host, final String
request path.
path)

Creates request message with the given method, host and request path.

public
BasicHttpRequest(final String
request method.
method, final URI
request URI.
requestUri)

Creates request message with the given method, request URI.

public
BasicHttpRequest(final Method
request method.
method, final String
request path.
path)

Creates request message with the given method and request path.

public
BasicHttpRequest(final Method
request method.
method, final HttpHost
request host.
host, final String
request path.
path)

Creates request message with the given method, host and request path.

public
BasicHttpRequest(final Method
request method.
method, final URI
request URI.
requestUri)

Creates request message with the given method, request URI.

Method Summary

Modifier and TypeMethod and Description
public void
addHeader(final String
the name of the header.
name, final Object
the value of the header, taken as the value's Object#toString().
value)

Implements org.apache.hc.core5.http.HttpMessage.addHeader.

Adds a header to this message.
private void
assembleRequestUri(final StringBuilder buf)

public URIAuthority
getAuthority()

Implements org.apache.hc.core5.http.HttpRequest.getAuthority.

Returns authority of this request message.
public String
getMethod()

Implements org.apache.hc.core5.http.HttpRequest.getMethod.

Returns method of this request message.
public String
getPath()

Implements org.apache.hc.core5.http.HttpRequest.getPath.

Returns URI path of this request message or null if not set.
public String
getRequestUri()

Implements org.apache.hc.core5.http.HttpRequest.getRequestUri.

Returns request URI of this request message.
public String
getScheme()

Implements org.apache.hc.core5.http.HttpRequest.getScheme.

Returns scheme of this request message.
public URI
getUri()

Implements org.apache.hc.core5.http.HttpRequest.getUri.

Returns full request URI of this request message.
public ProtocolVersion
getVersion()

Implements org.apache.hc.core5.http.HttpMessage.getVersion.

Returns protocol version or null when not available.
public void
setAbsoluteRequestUri(final boolean absoluteRequestUri)

Sets a flag that the getRequestUri() method should return the request URI in an absolute form.

public void
setAuthority(final URIAuthority authority)

Implements org.apache.hc.core5.http.HttpRequest.setAuthority.

Sets authority of this request message.
public void
setHeader(final String
the name of the header.
name, final Object
the value of the header, taken as the value's Object#toString().
value)

Implements org.apache.hc.core5.http.HttpMessage.setHeader.

Overwrites the first header with the same name.
public void
setPath(final String path)

Implements org.apache.hc.core5.http.HttpRequest.setPath.

Sets URI path of this request message.
public void
setScheme(final String scheme)

Implements org.apache.hc.core5.http.HttpRequest.setScheme.

Sets scheme of this request message.
public void
setUri(final URI
the request URI.
requestUri)

Implements org.apache.hc.core5.http.HttpRequest.setUri.

Sets the full request URI of this request message.
public void
setVersion(final ProtocolVersion version)

Implements org.apache.hc.core5.http.HttpMessage.setVersion.

Sets protocol version.
public String
toString()

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

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

Field Detail

absoluteRequestUriback to summary
private boolean absoluteRequestUri
authorityback to summary
private URIAuthority authority
methodback to summary
private final String method
pathback to summary
private String path
requestUriback to summary
private URI requestUri
schemeback to summary
private String scheme
serialVersionUIDback to summary
private static final long serialVersionUID

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

versionback to summary
private ProtocolVersion version

Constructor Detail

BasicHttpRequestback to summary
public BasicHttpRequest(final String method, final String scheme, final URIAuthority authority, final String path)

Creates request message with the given method, host and request path.

Parameters
method:String

request method.

scheme:String

request scheme.

authority:URIAuthority

request authority.

path:String

request path.

Since
5.1
BasicHttpRequestback to summary
public BasicHttpRequest(final String method, final String path)

Creates request message with the given method and request path.

Parameters
method:String

request method.

path:String

request path.

BasicHttpRequestback to summary
public BasicHttpRequest(final String method, final HttpHost host, final String path)

Creates request message with the given method, host and request path.

Parameters
method:String

request method.

host:HttpHost

request host.

path:String

request path.

Since
5.0
BasicHttpRequestback to summary
public BasicHttpRequest(final String method, final URI requestUri)

Creates request message with the given method, request URI.

Parameters
method:String

request method.

requestUri:URI

request URI.

Since
5.0
BasicHttpRequestback to summary
public BasicHttpRequest(final Method method, final String path)

Creates request message with the given method and request path.

Parameters
method:Method

request method.

path:String

request path.

Since
5.0
BasicHttpRequestback to summary
public BasicHttpRequest(final Method method, final HttpHost host, final String path)

Creates request message with the given method, host and request path.

Parameters
method:Method

request method.

host:HttpHost

request host.

path:String

request path.

Since
5.0
BasicHttpRequestback to summary
public BasicHttpRequest(final Method method, final URI requestUri)

Creates request message with the given method, request URI.

Parameters
method:Method

request method.

requestUri:URI

request URI.

Since
5.0

Method Detail

addHeaderback to summary
public void addHeader(final String name, final Object value)

Implements org.apache.hc.core5.http.HttpMessage.addHeader.

Doc from org.apache.hc.core5.http.HttpMessage.addHeader.

Adds a header to this message. The header will be appended to the end of the list.

Parameters
name:String

the name of the header.

value:Object

the value of the header, taken as the value's Object#toString().

Annotations
@Override
assembleRequestUriback to summary
private void assembleRequestUri(final StringBuilder buf)
getAuthorityback to summary
public URIAuthority getAuthority()

Implements org.apache.hc.core5.http.HttpRequest.getAuthority.

Doc from org.apache.hc.core5.http.HttpRequest.getAuthority.

Returns authority of this request message.

Returns:URIAuthority

the authority or null.

Annotations
@Override
getMethodback to summary
public String getMethod()

Implements org.apache.hc.core5.http.HttpRequest.getMethod.

Doc from org.apache.hc.core5.http.HttpRequest.getMethod.

Returns method of this request message.

Returns:String

the request method.

Annotations
@Override
getPathback to summary
public String getPath()

Implements org.apache.hc.core5.http.HttpRequest.getPath.

Doc from org.apache.hc.core5.http.HttpRequest.getPath.

Returns URI path of this request message or null if not set.

Returns:String

the request URI or null.

Annotations
@Override
getRequestUriback to summary
public String getRequestUri()

Implements org.apache.hc.core5.http.HttpRequest.getRequestUri.

Doc from org.apache.hc.core5.http.HttpRequest.getRequestUri.

Returns request URI of this request message. It may be an absolute or relative URI. Applicable to HTTP/1.1 version or earlier.

Returns:String

the request URI.

Annotations
@Override
getSchemeback to summary
public String getScheme()

Implements org.apache.hc.core5.http.HttpRequest.getScheme.

Doc from org.apache.hc.core5.http.HttpRequest.getScheme.

Returns scheme of this request message.

Returns:String

the scheme or null.

Annotations
@Override
getUriback to summary
public URI getUri() throws URISyntaxException

Implements org.apache.hc.core5.http.HttpRequest.getUri.

Doc from org.apache.hc.core5.http.HttpRequest.getUri.

Returns full request URI of this request message.

Returns:URI

the request URI.

Annotations
@Override
getVersionback to summary
public ProtocolVersion getVersion()

Implements org.apache.hc.core5.http.HttpMessage.getVersion.

Doc from org.apache.hc.core5.http.HttpMessage.getVersion.

Returns protocol version or null when not available.

For incoming messages it represents protocol version this message was transmitted with. For outgoing messages it represents a hint what protocol version should be used to transmit the message.

Annotations
@Override
setAbsoluteRequestUriback to summary
public void setAbsoluteRequestUri(final boolean absoluteRequestUri)

Sets a flag that the getRequestUri() method should return the request URI in an absolute form.

This flag can used when the request is going to be transmitted via an HTTP/1.1 proxy.

Since
5.1
setAuthorityback to summary
public void setAuthority(final URIAuthority authority)

Implements org.apache.hc.core5.http.HttpRequest.setAuthority.

Doc from org.apache.hc.core5.http.HttpRequest.setAuthority.

Sets authority of this request message.

Annotations
@Override
setHeaderback to summary
public void setHeader(final String name, final Object value)

Implements org.apache.hc.core5.http.HttpMessage.setHeader.

Doc from org.apache.hc.core5.http.HttpMessage.setHeader.

Overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.

Parameters
name:String

the name of the header.

value:Object

the value of the header, taken as the value's Object#toString().

Annotations
@Override
setPathback to summary
public void setPath(final String path)

Implements org.apache.hc.core5.http.HttpRequest.setPath.

Doc from org.apache.hc.core5.http.HttpRequest.setPath.

Sets URI path of this request message.

Annotations
@Override
setSchemeback to summary
public void setScheme(final String scheme)

Implements org.apache.hc.core5.http.HttpRequest.setScheme.

Doc from org.apache.hc.core5.http.HttpRequest.setScheme.

Sets scheme of this request message.

Annotations
@Override
setUriback to summary
public void setUri(final URI requestUri)

Implements org.apache.hc.core5.http.HttpRequest.setUri.

Doc from org.apache.hc.core5.http.HttpRequest.setUri.

Sets the full request URI of this request message.

Parameters
requestUri:URI

the request URI.

Annotations
@Override
setVersionback to summary
public void setVersion(final ProtocolVersion version)

Implements org.apache.hc.core5.http.HttpMessage.setVersion.

Doc from org.apache.hc.core5.http.HttpMessage.setVersion.

Sets protocol version.

For incoming messages it represents protocol version this message was transmitted with. For outgoing messages it represents a hint what protocol version should be used to transmit the message.

Annotations
@Override
toStringback to summary
public String toString()

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

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override