Package org.apache.hc.core5.http
Interface HttpRequest
- All Superinterfaces:
HttpMessage
,MessageHeaders
- All Known Subinterfaces:
ClassicHttpRequest
- All Known Implementing Classes:
BasicClassicHttpRequest
,BasicHttpRequest
,HttpRequestWrapper
A request message from a client to a server includes, within the
first line of that message, the method to be applied to the resource,
the identifier of the resource, and the protocol version in use.
- Since:
- 4.0
-
Method Summary
Modifier and TypeMethodDescriptionReturns authority of this request message.Returns method of this request message.getPath()
Returns URI path of this request message ornull
if not set.Returns request URI of this request message.Returns scheme of this request message.getUri()
Returns full request URI of this request message.void
setAuthority
(URIAuthority authority) Sets authority of this request message.void
Sets URI path of this request message.void
Sets scheme of this request message.void
Sets the full request URI of this request message.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
-
Method Details
-
getMethod
String getMethod()Returns method of this request message.- Returns:
- the request method.
-
getPath
String getPath()Returns URI path of this request message ornull
if not set.- Returns:
- the request URI or
null
.
-
setPath
Sets URI path of this request message.- Since:
- 5.0
-
getScheme
String getScheme()Returns scheme of this request message.- Returns:
- the scheme or
null
. - Since:
- 5.0
-
setScheme
Sets scheme of this request message.- Since:
- 5.0
-
getAuthority
URIAuthority getAuthority()Returns authority of this request message.- Returns:
- the authority or
null
. - Since:
- 5.0
-
setAuthority
Sets authority of this request message.- Since:
- 5.0
-
getRequestUri
String 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:
- the request URI.
- Since:
- 5.0
-
getUri
Returns full request URI of this request message.- Returns:
- the request URI.
- Throws:
URISyntaxException
- Since:
- 5.0
-
setUri
Sets the full request URI of this request message.- Parameters:
requestUri
- the request URI.- Since:
- 5.0
-