Interface HttpRequest
-
- All Superinterfaces:
HttpMetaData
,HttpRequestMetaData
public interface HttpRequest extends HttpRequestMetaData
An HTTP request. The payload is represented as a singleObject
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default HttpRequest
addCookie(HttpCookiePair cookie)
Adds a cookie.default HttpRequest
addCookie(java.lang.CharSequence name, java.lang.CharSequence value)
default HttpRequest
addHeader(java.lang.CharSequence name, java.lang.CharSequence value)
Adds a new header with the specifiedname
andvalue
.default HttpRequest
addHeaders(HttpHeaders headers)
Adds all header names and values ofheaders
object.HttpRequest
addQueryParameter(java.lang.String key, java.lang.String value)
Adds a new query parameter with the specifiedkey
andvalue
, which will be percent-encoded if needed.HttpRequest
addQueryParameters(java.lang.String key, java.lang.Iterable<java.lang.String> values)
Adds new query parameters with the specifiedkey
andvalues
.HttpRequest
addQueryParameters(java.lang.String key, java.lang.String... values)
Adds new query parameters with the specifiedkey
andvalues
.default HttpRequest
addSetCookie(HttpSetCookie cookie)
Adds a set-cookie.default HttpRequest
addSetCookie(java.lang.CharSequence name, java.lang.CharSequence value)
default HttpRequest
addTrailer(java.lang.CharSequence name, java.lang.CharSequence value)
default HttpRequest
addTrailers(HttpHeaders trailers)
HttpRequest
appendPathSegments(java.lang.String... segments)
Appends segments to the currentHttpRequestMetaData.path()
, performing encoding of each segment (including ('/'
) characters) according to percent-encoding.HttpRequest
encoding(ContentCodec encoding)
TheContentCodec
used to encode the payload of a request or a response.HttpRequest
method(HttpRequestMethod method)
Set theHttpRequestMethod
of thisStreamingHttpRequest
.HttpRequest
path(java.lang.String path)
Sets the path, performing encoding according to percent-encoding, except for forward-slash ('/'
) characters.Buffer
payloadBody()
Gets the underlying payload as aBuffer
.HttpRequest
payloadBody(Buffer payloadBody)
Returns anHttpRequest
with its underlying payload set topayloadBody
.default <T> T
payloadBody(HttpDeserializer<T> deserializer)
Gets and deserializes the payload body.<T> HttpRequest
payloadBody(T pojo, HttpSerializer<T> serializer)
Returns anHttpRequest
with its underlying payload set to the results of serialization ofpojo
.HttpRequest
query(java.lang.String query)
Sets the path, performing encoding according to rfc3986, Query.HttpRequest
rawPath(java.lang.String path)
Sets the path topath
, without any encoding performed.HttpRequest
rawQuery(java.lang.String query)
Sets the query component toquery
, without any encoding performed.HttpRequest
requestTarget(java.lang.String requestTarget)
Set the request-target.HttpRequest
requestTarget(java.lang.String requestTarget, java.nio.charset.Charset encoding)
Set the request-target.default HttpRequest
setHeader(java.lang.CharSequence name, java.lang.CharSequence value)
Sets a header with the specifiedname
andvalue
.default HttpRequest
setHeaders(HttpHeaders headers)
Clears the current header entries and copies all header entries of the specifiedheaders
object.HttpRequest
setQueryParameter(java.lang.String key, java.lang.String value)
HttpRequest
setQueryParameters(java.lang.String key, java.lang.Iterable<java.lang.String> values)
Sets new query parameters with the specifiedkey
andvalues
.HttpRequest
setQueryParameters(java.lang.String key, java.lang.String... values)
Sets new query parameters with the specifiedkey
andvalues
.default HttpRequest
setTrailer(java.lang.CharSequence name, java.lang.CharSequence value)
default HttpRequest
setTrailers(HttpHeaders trailers)
BlockingStreamingHttpRequest
toBlockingStreamingRequest()
Translates thisHttpRequest
to aBlockingStreamingHttpRequest
.StreamingHttpRequest
toStreamingRequest()
Translates thisHttpRequest
to aStreamingHttpRequest
.HttpHeaders
trailers()
Gets the trailers.HttpRequest
version(HttpProtocolVersion version)
Set the protocol version of thisHttpMetaData
.-
Methods inherited from interface io.servicetalk.http.api.HttpMetaData
encoding, headers, toString, toString, version
-
Methods inherited from interface io.servicetalk.http.api.HttpRequestMetaData
effectiveHostAndPort, hasQueryParameter, hasQueryParameter, host, method, path, port, query, queryParameter, queryParameters, queryParameters, queryParametersIterator, queryParametersKeys, queryParametersSize, rawPath, rawQuery, removeQueryParameters, removeQueryParameters, requestTarget, requestTarget, scheme, userInfo
-
-
-
-
Method Detail
-
payloadBody
Buffer payloadBody()
Gets the underlying payload as aBuffer
.- Returns:
- The
Buffer
representation of the underlying payload.
-
payloadBody
default <T> T payloadBody(HttpDeserializer<T> deserializer)
Gets and deserializes the payload body.- Type Parameters:
T
- The resulting type of the deserialization operation.- Parameters:
deserializer
- The function that deserializes the underlyingObject
.- Returns:
- The results of the deserialization operation.
-
payloadBody
HttpRequest payloadBody(Buffer payloadBody)
Returns anHttpRequest
with its underlying payload set topayloadBody
.- Parameters:
payloadBody
- the underlying payload.- Returns:
this
-
payloadBody
<T> HttpRequest payloadBody(T pojo, HttpSerializer<T> serializer)
Returns anHttpRequest
with its underlying payload set to the results of serialization ofpojo
.- Type Parameters:
T
- The type of object to serialize.- Parameters:
pojo
- The object to serialize.serializer
- TheHttpSerializer
which convertspojo
into bytes.- Returns:
this
-
toStreamingRequest
StreamingHttpRequest toStreamingRequest()
Translates thisHttpRequest
to aStreamingHttpRequest
.- Returns:
- a
StreamingHttpRequest
representation of thisHttpRequest
.
-
toBlockingStreamingRequest
BlockingStreamingHttpRequest toBlockingStreamingRequest()
Translates thisHttpRequest
to aBlockingStreamingHttpRequest
.- Returns:
- a
BlockingStreamingHttpRequest
representation of thisHttpRequest
.
-
rawPath
HttpRequest rawPath(java.lang.String path)
Description copied from interface:HttpRequestMetaData
Sets the path topath
, without any encoding performed. This assumes that any characters that require encoding have been encoded according to percent-encoding by the caller.Because this modifies the request target, this may result in the clearing of internal caches. See
HttpRequestMetaData.requestTarget(String)
.- Specified by:
rawPath
in interfaceHttpRequestMetaData
- Parameters:
path
- the encoded path to set.- Returns:
this
.
-
path
HttpRequest path(java.lang.String path)
Description copied from interface:HttpRequestMetaData
Sets the path, performing encoding according to percent-encoding, except for forward-slash ('/'
) characters. This allows forpath("/abc")
without it turning into'%2Fabc'
.- Specified by:
path
in interfaceHttpRequestMetaData
- Parameters:
path
- the un-encoded path to set.- Returns:
this
.
-
appendPathSegments
HttpRequest appendPathSegments(java.lang.String... segments)
Description copied from interface:HttpRequestMetaData
Appends segments to the currentHttpRequestMetaData.path()
, performing encoding of each segment (including ('/'
) characters) according to percent-encoding. A/
is used to separate each segment and between the currentHttpRequestMetaData.path()
and the following segments.- Specified by:
appendPathSegments
in interfaceHttpRequestMetaData
- Parameters:
segments
- the un-encoded path to set.- Returns:
this
.
-
rawQuery
HttpRequest rawQuery(@Nullable java.lang.String query)
Description copied from interface:HttpRequestMetaData
Sets the query component toquery
, without any encoding performed. This assumes that any characters that require encoding have been encoded according to percent-encoding by the caller.Because this modifies the request target, this may result in the clearing of internal caches. See
HttpRequestMetaData.requestTarget(String)
.- Specified by:
rawQuery
in interfaceHttpRequestMetaData
- Parameters:
query
- the encoded query to set.null
will clear the query value (e.g. no?
present inHttpRequestMetaData.requestTarget()
.- Returns:
this
.
-
query
HttpRequest query(@Nullable java.lang.String query)
Description copied from interface:HttpRequestMetaData
Sets the path, performing encoding according to rfc3986, Query.- Specified by:
query
in interfaceHttpRequestMetaData
- Parameters:
query
- the un-encoded query to set.null
will clear the query value (e.g. no?
present inHttpRequestMetaData.requestTarget()
.- Returns:
this
.
-
addQueryParameter
HttpRequest addQueryParameter(java.lang.String key, java.lang.String value)
Description copied from interface:HttpRequestMetaData
Adds a new query parameter with the specifiedkey
andvalue
, which will be percent-encoded if needed.- Specified by:
addQueryParameter
in interfaceHttpRequestMetaData
- Parameters:
key
- the query parameter key.value
- the query parameter value.- Returns:
this
.
-
addQueryParameters
HttpRequest addQueryParameters(java.lang.String key, java.lang.Iterable<java.lang.String> values)
Description copied from interface:HttpRequestMetaData
Adds new query parameters with the specifiedkey
andvalues
. This method is semantically equivalent to:for (T value : values) { addQueryParameter(key, value); }
- Specified by:
addQueryParameters
in interfaceHttpRequestMetaData
- Parameters:
key
- the query parameter key.values
- the query parameter values.- Returns:
this
.
-
addQueryParameters
HttpRequest addQueryParameters(java.lang.String key, java.lang.String... values)
Description copied from interface:HttpRequestMetaData
Adds new query parameters with the specifiedkey
andvalues
. This method is semantically equivalent to:for (T value : values) { query.addQueryParameter(key, value); }
- Specified by:
addQueryParameters
in interfaceHttpRequestMetaData
- Parameters:
key
- the query parameter key.values
- the query parameter values.- Returns:
this
.
-
setQueryParameter
HttpRequest setQueryParameter(java.lang.String key, java.lang.String value)
Description copied from interface:HttpRequestMetaData
Sets a query parameter with the specifiedkey
andvalue
, which will be percent-encoded if needed. Any existing query parameters with the same key are overwritten.- Specified by:
setQueryParameter
in interfaceHttpRequestMetaData
- Parameters:
key
- the query parameter key.value
- the query parameter value.- Returns:
this
.
-
setQueryParameters
HttpRequest setQueryParameters(java.lang.String key, java.lang.Iterable<java.lang.String> values)
Description copied from interface:HttpRequestMetaData
Sets new query parameters with the specifiedkey
andvalues
. This method is equivalent to:removeQueryParameter(key); for (T value : values) { query.addQueryParameter(key, value); }
- Specified by:
setQueryParameters
in interfaceHttpRequestMetaData
- Parameters:
key
- the query parameter key.values
- the query parameter values.- Returns:
this
.
-
setQueryParameters
HttpRequest setQueryParameters(java.lang.String key, java.lang.String... values)
Description copied from interface:HttpRequestMetaData
Sets new query parameters with the specifiedkey
andvalues
. This method is equivalent to:removeQueryParameter(key); for (T value : values) { query.addQueryParameter(key, value); }
- Specified by:
setQueryParameters
in interfaceHttpRequestMetaData
- Parameters:
key
- the query parameter key.values
- the query parameter values.- Returns:
this
.
-
version
HttpRequest version(HttpProtocolVersion version)
Description copied from interface:HttpMetaData
Set the protocol version of thisHttpMetaData
.- Specified by:
version
in interfaceHttpMetaData
- Specified by:
version
in interfaceHttpRequestMetaData
- Parameters:
version
- the protocol version to set.- Returns:
this
.
-
encoding
HttpRequest encoding(ContentCodec encoding)
Description copied from interface:HttpMetaData
TheContentCodec
used to encode the payload of a request or a response. If the endpoint is setup withContentCodingHttpServiceFilter
, the server will auto-establish the accepted encoding for the response, unless the caller provides a specific encoding by calling this method. Any encoding passed here, takes precedence. In other words, a compressed response, can be disabled by passingContentCodings.identity()
.- Specified by:
encoding
in interfaceHttpMetaData
- Parameters:
encoding
- TheContentCodec
used for the encoding of the payload.- Returns:
this
.- See Also:
- Content-Encoding
-
method
HttpRequest method(HttpRequestMethod method)
Description copied from interface:HttpRequestMetaData
Set theHttpRequestMethod
of thisStreamingHttpRequest
.- Specified by:
method
in interfaceHttpRequestMetaData
- Parameters:
method
- theHttpRequestMethod
to set.- Returns:
this
.
-
requestTarget
HttpRequest requestTarget(java.lang.String requestTarget)
Description copied from interface:HttpRequestMetaData
Set the request-target.This will be treated as encoded according to percent-encoding.
This may result in clearing of internal caches used by methods that are derived from the
request-target
, such asHttpRequestMetaData.path()
,HttpRequestMetaData.rawQuery()
, etc.- Specified by:
requestTarget
in interfaceHttpRequestMetaData
- Parameters:
requestTarget
- the percent-encoded request-target to set.- Returns:
this
.
-
requestTarget
HttpRequest requestTarget(java.lang.String requestTarget, java.nio.charset.Charset encoding)
Description copied from interface:HttpRequestMetaData
Set the request-target.This may result in clearing of internal caches used by methods that are derived from the
request-target
, such asHttpRequestMetaData.path()
,HttpRequestMetaData.rawQuery()
, etc.- Specified by:
requestTarget
in interfaceHttpRequestMetaData
- Parameters:
requestTarget
- the request-target to set.encoding
- theCharset
to use to encoderequestTarget
before setting the value.- Returns:
this
.
-
addHeader
default HttpRequest addHeader(java.lang.CharSequence name, java.lang.CharSequence value)
Description copied from interface:HttpMetaData
Adds a new header with the specifiedname
andvalue
.- Specified by:
addHeader
in interfaceHttpMetaData
- Specified by:
addHeader
in interfaceHttpRequestMetaData
- Parameters:
name
- the name of the header.value
- the value of the header.- Returns:
this
.
-
addHeaders
default HttpRequest addHeaders(HttpHeaders headers)
Description copied from interface:HttpMetaData
Adds all header names and values ofheaders
object.- Specified by:
addHeaders
in interfaceHttpMetaData
- Specified by:
addHeaders
in interfaceHttpRequestMetaData
- Parameters:
headers
- the headers to add.- Returns:
this
.
-
setHeader
default HttpRequest setHeader(java.lang.CharSequence name, java.lang.CharSequence value)
Description copied from interface:HttpMetaData
Sets a header with the specifiedname
andvalue
. Any existing headers with the same name are overwritten.- Specified by:
setHeader
in interfaceHttpMetaData
- Specified by:
setHeader
in interfaceHttpRequestMetaData
- Parameters:
name
- the name of the header.value
- the value of the header.- Returns:
this
.
-
setHeaders
default HttpRequest setHeaders(HttpHeaders headers)
Description copied from interface:HttpMetaData
Clears the current header entries and copies all header entries of the specifiedheaders
object.- Specified by:
setHeaders
in interfaceHttpMetaData
- Specified by:
setHeaders
in interfaceHttpRequestMetaData
- Parameters:
headers
- the headers object which contains new values.- Returns:
this
.
-
addCookie
default HttpRequest addCookie(HttpCookiePair cookie)
Description copied from interface:HttpMetaData
Adds a cookie.This may result in multiple
HttpCookiePair
s with same name.- Specified by:
addCookie
in interfaceHttpMetaData
- Specified by:
addCookie
in interfaceHttpRequestMetaData
- Parameters:
cookie
- the cookie to add.- Returns:
this
.
-
addCookie
default HttpRequest addCookie(java.lang.CharSequence name, java.lang.CharSequence value)
Description copied from interface:HttpMetaData
Adds a cookie with the specifiedname
andvalue
.This may result in multiple
HttpSetCookie
s with same name. Added cookie will not be wrapped, not secure, and not HTTP-only, with no path, domain, expire date and maximum age.- Specified by:
addCookie
in interfaceHttpMetaData
- Specified by:
addCookie
in interfaceHttpRequestMetaData
- Parameters:
name
- the name of the cookie.value
- the value of the cookie.- Returns:
this
.
-
addSetCookie
default HttpRequest addSetCookie(HttpSetCookie cookie)
Description copied from interface:HttpMetaData
Adds a set-cookie.This may result in multiple
HttpSetCookie
s with same name.- Specified by:
addSetCookie
in interfaceHttpMetaData
- Specified by:
addSetCookie
in interfaceHttpRequestMetaData
- Parameters:
cookie
- the cookie to add.- Returns:
this
.
-
addSetCookie
default HttpRequest addSetCookie(java.lang.CharSequence name, java.lang.CharSequence value)
Description copied from interface:HttpMetaData
Adds a set-cookie with the specifiedname
andvalue
.This may result in multiple
HttpSetCookie
s with same name. Added cookie will not be wrapped, not secure, and not HTTP-only, with no path, domain, expire date and maximum age.- Specified by:
addSetCookie
in interfaceHttpMetaData
- Specified by:
addSetCookie
in interfaceHttpRequestMetaData
- Parameters:
name
- the name of the cookie.value
- the value of the cookie.- Returns:
this
.
-
addTrailer
default HttpRequest addTrailer(java.lang.CharSequence name, java.lang.CharSequence value)
-
addTrailers
default HttpRequest addTrailers(HttpHeaders trailers)
-
setTrailer
default HttpRequest setTrailer(java.lang.CharSequence name, java.lang.CharSequence value)
-
setTrailers
default HttpRequest setTrailers(HttpHeaders trailers)
-
trailers
HttpHeaders trailers()
Gets the trailers.- Returns:
- the trailers.
-
-