Package org.apache.hc.core5.http.message
Class BasicHttpRequest
- java.lang.Object
-
- org.apache.hc.core5.http.message.HeaderGroup
-
- org.apache.hc.core5.http.message.BasicHttpRequest
-
- All Implemented Interfaces:
java.io.Serializable
,HttpMessage
,HttpRequest
,MessageHeaders
- Direct Known Subclasses:
BasicClassicHttpRequest
public class BasicHttpRequest extends HeaderGroup implements HttpRequest
Basic implementation ofHttpRequest
.- Since:
- 4.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
absoluteRequestUri
private URIAuthority
authority
private java.lang.String
method
private java.lang.String
path
private java.net.URI
requestUri
private java.lang.String
scheme
private static long
serialVersionUID
private ProtocolVersion
version
-
Constructor Summary
Constructors Constructor Description BasicHttpRequest(java.lang.String method, java.lang.String path)
Creates request message with the given method and request path.BasicHttpRequest(java.lang.String method, java.lang.String scheme, URIAuthority authority, java.lang.String path)
Creates request message with the given method, host and request path.BasicHttpRequest(java.lang.String method, java.net.URI requestUri)
Creates request message with the given method, request URI.BasicHttpRequest(java.lang.String method, HttpHost host, java.lang.String path)
Creates request message with the given method, host and request path.BasicHttpRequest(Method method, java.lang.String path)
Creates request message with the given method and request path.BasicHttpRequest(Method method, java.net.URI requestUri)
Creates request message with the given method, request URI.BasicHttpRequest(Method method, HttpHost host, java.lang.String path)
Creates request message with the given method, host and request path.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addHeader(java.lang.String name, java.lang.Object value)
Adds a header to this message.private void
assembleRequestUri(java.lang.StringBuilder buf)
URIAuthority
getAuthority()
Returns authority of this request message.java.lang.String
getMethod()
Returns method of this request message.java.lang.String
getPath()
Returns URI path of this request message ornull
if not set.java.lang.String
getRequestUri()
Returns request URI of this request message.java.lang.String
getScheme()
Returns scheme of this request message.java.net.URI
getUri()
Returns full request URI of this request message.ProtocolVersion
getVersion()
Returns protocol version ornull
when not available.void
setAbsoluteRequestUri(boolean absoluteRequestUri)
Sets a flag that thegetRequestUri()
method should return the request URI in an absolute form.void
setAuthority(URIAuthority authority)
Sets authority of this request message.void
setHeader(java.lang.String name, java.lang.Object value)
Overwrites the first header with the same name.void
setPath(java.lang.String path)
Sets URI path of this request message.void
setScheme(java.lang.String scheme)
Sets scheme of this request message.void
setUri(java.net.URI requestUri)
Sets the full request URI of this request message.void
setVersion(ProtocolVersion version)
Sets protocol version.java.lang.String
toString()
-
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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.hc.core5.http.HttpMessage
addHeader, removeHeader, removeHeaders, setHeader, setHeaders
-
Methods inherited from interface org.apache.hc.core5.http.MessageHeaders
containsHeader, countHeaders, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
method
private final java.lang.String method
-
path
private java.lang.String path
-
scheme
private java.lang.String scheme
-
authority
private URIAuthority authority
-
version
private ProtocolVersion version
-
requestUri
private java.net.URI requestUri
-
absoluteRequestUri
private boolean absoluteRequestUri
-
-
Constructor Detail
-
BasicHttpRequest
public BasicHttpRequest(java.lang.String method, java.lang.String scheme, URIAuthority authority, java.lang.String path)
Creates request message with the given method, host and request path.- Parameters:
method
- request method.scheme
- request scheme.authority
- request authority.path
- request path.- Since:
- 5.1
-
BasicHttpRequest
public BasicHttpRequest(java.lang.String method, java.lang.String path)
Creates request message with the given method and request path.- Parameters:
method
- request method.path
- request path.
-
BasicHttpRequest
public BasicHttpRequest(java.lang.String method, HttpHost host, java.lang.String path)
Creates request message with the given method, host and request path.- Parameters:
method
- request method.host
- request host.path
- request path.- Since:
- 5.0
-
BasicHttpRequest
public BasicHttpRequest(java.lang.String method, java.net.URI requestUri)
Creates request message with the given method, request URI.- Parameters:
method
- request method.requestUri
- request URI.- Since:
- 5.0
-
BasicHttpRequest
public BasicHttpRequest(Method method, java.lang.String path)
Creates request message with the given method and request path.- Parameters:
method
- request method.path
- request path.- Since:
- 5.0
-
BasicHttpRequest
public BasicHttpRequest(Method method, HttpHost host, java.lang.String path)
Creates request message with the given method, host and request path.- Parameters:
method
- request method.host
- request host.path
- request path.- Since:
- 5.0
-
BasicHttpRequest
public BasicHttpRequest(Method method, java.net.URI requestUri)
Creates request message with the given method, request URI.- Parameters:
method
- request method.requestUri
- request URI.- Since:
- 5.0
-
-
Method Detail
-
addHeader
public void addHeader(java.lang.String name, java.lang.Object value)
Description copied from interface:HttpMessage
Adds a header to this message. The header will be appended to the end of the list.- Specified by:
addHeader
in interfaceHttpMessage
- Parameters:
name
- the name of the header.value
- the value of the header, taken as the value'sObject.toString()
.
-
setHeader
public void setHeader(java.lang.String name, java.lang.Object value)
Description copied from interface:HttpMessage
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.- Specified by:
setHeader
in interfaceHttpMessage
- Parameters:
name
- the name of the header.value
- the value of the header, taken as the value'sObject.toString()
.
-
setVersion
public void setVersion(ProtocolVersion version)
Description copied from interface:HttpMessage
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.
- Specified by:
setVersion
in interfaceHttpMessage
-
getVersion
public ProtocolVersion getVersion()
Description copied from interface:HttpMessage
Returns protocol version ornull
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.
- Specified by:
getVersion
in interfaceHttpMessage
-
getMethod
public java.lang.String getMethod()
Description copied from interface:HttpRequest
Returns method of this request message.- Specified by:
getMethod
in interfaceHttpRequest
- Returns:
- the request method.
-
getPath
public java.lang.String getPath()
Description copied from interface:HttpRequest
Returns URI path of this request message ornull
if not set.- Specified by:
getPath
in interfaceHttpRequest
- Returns:
- the request URI or
null
.
-
setPath
public void setPath(java.lang.String path)
Description copied from interface:HttpRequest
Sets URI path of this request message.- Specified by:
setPath
in interfaceHttpRequest
-
getScheme
public java.lang.String getScheme()
Description copied from interface:HttpRequest
Returns scheme of this request message.- Specified by:
getScheme
in interfaceHttpRequest
- Returns:
- the scheme or
null
.
-
setScheme
public void setScheme(java.lang.String scheme)
Description copied from interface:HttpRequest
Sets scheme of this request message.- Specified by:
setScheme
in interfaceHttpRequest
-
getAuthority
public URIAuthority getAuthority()
Description copied from interface:HttpRequest
Returns authority of this request message.- Specified by:
getAuthority
in interfaceHttpRequest
- Returns:
- the authority or
null
.
-
setAuthority
public void setAuthority(URIAuthority authority)
Description copied from interface:HttpRequest
Sets authority of this request message.- Specified by:
setAuthority
in interfaceHttpRequest
-
setAbsoluteRequestUri
public void setAbsoluteRequestUri(boolean absoluteRequestUri)
Sets a flag that thegetRequestUri()
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
-
getRequestUri
public java.lang.String getRequestUri()
Description copied from interface:HttpRequest
Returns request URI of this request message. It may be an absolute or relative URI. Applicable to HTTP/1.1 version or earlier.- Specified by:
getRequestUri
in interfaceHttpRequest
- Returns:
- the request URI.
-
setUri
public void setUri(java.net.URI requestUri)
Description copied from interface:HttpRequest
Sets the full request URI of this request message.- Specified by:
setUri
in interfaceHttpRequest
- Parameters:
requestUri
- the request URI.
-
assembleRequestUri
private void assembleRequestUri(java.lang.StringBuilder buf)
-
getUri
public java.net.URI getUri() throws java.net.URISyntaxException
Description copied from interface:HttpRequest
Returns full request URI of this request message.- Specified by:
getUri
in interfaceHttpRequest
- Returns:
- the request URI.
- Throws:
java.net.URISyntaxException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classHeaderGroup
-
-