Package io.servicetalk.http.api

Interface HttpRequest

All Superinterfaces:

ContextMapHolder, HttpMetaData, HttpRequestMetaData

public interface HttpRequest
extends HttpRequestMetaData

An HTTP request. The payload is represented as a single Object.

Method Summary

Modifier and Type	Method	Description
default HttpRequest	addCookie(HttpCookiePair cookie)	Adds a cookie.
default HttpRequest	addCookie(CharSequence name, CharSequence value)	Adds a cookie with the specified name and value.
default HttpRequest	addHeader(CharSequence name, CharSequence value)	Adds a new header with the specified name and value.
default HttpRequest	addHeaders(HttpHeaders headers)	Adds all header names and values of headers object.
HttpRequest	addQueryParameter(String key, String value)	Adds a new query parameter with the specified key and value, which will be percent-encoded if needed.
HttpRequest	addQueryParameters(String key, Iterable<String> values)	Adds new query parameters with the specified key and values.
HttpRequest	addQueryParameters(String key, String... values)	Adds new query parameters with the specified key and values.
default HttpRequest	addSetCookie(HttpSetCookie cookie)	Adds a set-cookie.
default HttpRequest	addSetCookie(CharSequence name, CharSequence value)	Adds a set-cookie with the specified name and value.
default HttpRequest	addTrailer(CharSequence name, CharSequence value)
default HttpRequest	addTrailers(HttpHeaders trailers)
HttpRequest	appendPathSegments(String... segments)	Appends segments to the current HttpRequestMetaData.path(), performing encoding of each segment (including ('/') characters) according to percent-encoding.
HttpRequest	contentEncoding(BufferEncoder encoder)	Set the BufferEncoder to use for this request.
HttpRequest	context(ContextMap context)	Sets a context for this HttpMetaData.
default HttpRequest	encoding(ContentCodec encoding)	Deprecated.
default HttpRequest	fragment(String fragment)	Sets the fragment part of the request target.
HttpRequest	method(HttpRequestMethod method)	Set the HttpRequestMethod of this StreamingHttpRequest.
HttpRequest	path(String path)	Sets the path, performing encoding according to percent-encoding, except for forward-slash ('/') characters.
Buffer	payloadBody()	Gets the underlying payload as a Buffer.
HttpRequest	payloadBody(Buffer payloadBody)	Returns an HttpRequest with its underlying payload set to payloadBody.
default <T> T	payloadBody(HttpDeserializer<T> deserializer)	Deprecated. Use payloadBody(HttpDeserializer2).
<T> T	payloadBody(HttpDeserializer2<T> deserializer)	Gets and deserializes the payload body.
default <T> HttpRequest	payloadBody(T pojo, HttpSerializer<T> serializer)	Deprecated. Use payloadBody(Object, HttpSerializer2).
<T> HttpRequest	payloadBody(T pojo, HttpSerializer2<T> serializer)	Returns an HttpRequest with its underlying payload set to the results of serialization of pojo.
HttpRequest	query(String query)	Sets the path, performing encoding according to rfc3986, Query.
HttpRequest	rawPath(String path)	Sets the path to path, without any encoding performed.
HttpRequest	rawQuery(String query)	Sets the query component to query, without any encoding performed.
HttpRequest	requestTarget(String requestTarget)	Set the request-target.
HttpRequest	requestTarget(String requestTarget, Charset encoding)	Set the request-target.
default HttpRequest	setHeader(CharSequence name, CharSequence value)	Sets a header with the specified name and value.
default HttpRequest	setHeaders(HttpHeaders headers)	Clears the current header entries and copies all header entries of the specified headers object.
HttpRequest	setQueryParameter(String key, String value)	Sets a query parameter with the specified key and value, which will be percent-encoded if needed.
HttpRequest	setQueryParameters(String key, Iterable<String> values)	Sets new query parameters with the specified key and values.
HttpRequest	setQueryParameters(String key, String... values)	Sets new query parameters with the specified key and values.
default HttpRequest	setTrailer(CharSequence name, CharSequence value)
default HttpRequest	setTrailers(HttpHeaders trailers)
BlockingStreamingHttpRequest	toBlockingStreamingRequest()	Translates this HttpRequest to a BlockingStreamingHttpRequest.
StreamingHttpRequest	toStreamingRequest()	Translates this HttpRequest to a StreamingHttpRequest.
HttpHeaders	trailers()	Gets the trailers.
HttpRequest	version(HttpProtocolVersion version)	Set the protocol version of this HttpMetaData.

Methods inherited from interface io.servicetalk.http.api.HttpMetaData

context, encoding, headers, toString, toString, version

Methods inherited from interface io.servicetalk.http.api.HttpRequestMetaData

contentEncoding, effectiveHostAndPort, fragment, hasQueryParameter, hasQueryParameter, host, method, path, port, query, queryParameter, queryParameters, queryParameters, queryParametersIterator, queryParametersKeys, queryParametersSize, rawPath, rawQuery, removeQueryParameters, removeQueryParameters, requestTarget, requestTarget, scheme, userInfo

Method Details

payloadBody

Buffer payloadBody()

Gets the underlying payload as a Buffer.

Returns:

The Buffer representation of the underlying payload.

payloadBody

@Deprecated
default <T> T payloadBody(HttpDeserializer<T> deserializer)

Deprecated.

Use payloadBody(HttpDeserializer2).

Gets and deserializes the payload body.

Type Parameters:

T - The resulting type of the deserialization operation.

Parameters:

deserializer - The function that deserializes the underlying Object.

Returns:

The results of the deserialization operation.

payloadBody

<T> T payloadBody(HttpDeserializer2<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 underlying Object.

Returns:

The results of the deserialization operation.

payloadBody

HttpRequest payloadBody(Buffer payloadBody)

Returns an HttpRequest with its underlying payload set to payloadBody.

Parameters:

payloadBody - the underlying payload.

Returns:

this

payloadBody

@Deprecated
default <T> HttpRequest payloadBody(T pojo,
 HttpSerializer<T> serializer)

Deprecated.

Use payloadBody(Object, HttpSerializer2).

Returns an HttpRequest with its underlying payload set to the results of serialization of pojo.

Type Parameters:

T - The type of object to serialize.

Parameters:

pojo - The object to serialize.

serializer - The HttpSerializer which converts pojo into bytes.

Returns:

this

payloadBody

<T> HttpRequest payloadBody(T pojo,
 HttpSerializer2<T> serializer)

Returns an HttpRequest with its underlying payload set to the results of serialization of pojo.

Type Parameters:

T - The type of object to serialize.

Parameters:

pojo - The object to serialize.

serializer - The HttpSerializer2 which converts pojo into bytes.

Returns:

this

toStreamingRequest

StreamingHttpRequest toStreamingRequest()

Translates this HttpRequest to a StreamingHttpRequest.

Returns:

a StreamingHttpRequest representation of this HttpRequest.

toBlockingStreamingRequest

BlockingStreamingHttpRequest toBlockingStreamingRequest()

Translates this HttpRequest to a BlockingStreamingHttpRequest.

Returns:

a BlockingStreamingHttpRequest representation of this HttpRequest.

rawPath

HttpRequest rawPath(String path)

Description copied from interface: HttpRequestMetaData

Sets the path to path, 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 interface HttpRequestMetaData

Parameters:

path - the encoded path to set.

Returns:

this.

path

HttpRequest path(String path)

Description copied from interface: HttpRequestMetaData

Sets the path, performing encoding according to percent-encoding, except for forward-slash ('/') characters. This allows for path("/abc") without it turning into '%2Fabc'.

Specified by:

path in interface HttpRequestMetaData

Parameters:

path - the un-encoded path to set.

Returns:

this.

appendPathSegments

HttpRequest appendPathSegments(String... segments)

Description copied from interface: HttpRequestMetaData

Appends segments to the current HttpRequestMetaData.path(), performing encoding of each segment (including ('/') characters) according to percent-encoding. A / is used to separate each segment and between the current HttpRequestMetaData.path() and the following segments.

Specified by:

appendPathSegments in interface HttpRequestMetaData

Parameters:

segments - the un-encoded path to set.

Returns:

this.

rawQuery

HttpRequest rawQuery(@Nullable
 String query)

Description copied from interface: HttpRequestMetaData

Sets the query component to query, 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 interface HttpRequestMetaData

Parameters:

query - the encoded query to set. null will clear the query value (e.g. no ? present in HttpRequestMetaData.requestTarget().

Returns:

this.

query

HttpRequest query(@Nullable
 String query)

Description copied from interface: HttpRequestMetaData

Sets the path, performing encoding according to rfc3986, Query.

Specified by:

query in interface HttpRequestMetaData

Parameters:

query - the un-encoded query to set. null will clear the query value (e.g. no ? present in HttpRequestMetaData.requestTarget().

Returns:

this.

addQueryParameter

HttpRequest addQueryParameter(String key,
 String value)

Description copied from interface: HttpRequestMetaData

Adds a new query parameter with the specified key and value, which will be percent-encoded if needed.

Specified by:

addQueryParameter in interface HttpRequestMetaData

Parameters:

key - the query parameter key.

value - the query parameter value.

Returns:

this.

addQueryParameters

HttpRequest addQueryParameters(String key,
 Iterable<String> values)

Description copied from interface: HttpRequestMetaData

Adds new query parameters with the specified key and values. This method is semantically equivalent to:

 for (T value : values) {
     addQueryParameter(key, value);
 }
 

Specified by:

addQueryParameters in interface HttpRequestMetaData

Parameters:

key - the query parameter key.

values - the query parameter values.

Returns:

this.

addQueryParameters

HttpRequest addQueryParameters(String key,
 String... values)

Description copied from interface: HttpRequestMetaData

Adds new query parameters with the specified key and values. This method is semantically equivalent to:

 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 

Specified by:

addQueryParameters in interface HttpRequestMetaData

Parameters:

key - the query parameter key.

values - the query parameter values.

Returns:

this.

setQueryParameter

HttpRequest setQueryParameter(String key,
 String value)

Description copied from interface: HttpRequestMetaData

Sets a query parameter with the specified key and value, which will be percent-encoded if needed. Any existing query parameters with the same key are overwritten.

Specified by:

setQueryParameter in interface HttpRequestMetaData

Parameters:

key - the query parameter key.

value - the query parameter value.

Returns:

this.

setQueryParameters

HttpRequest setQueryParameters(String key,
 Iterable<String> values)

Description copied from interface: HttpRequestMetaData

Sets new query parameters with the specified key and values. This method is equivalent to:

 removeQueryParameter(key);
 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 

Specified by:

setQueryParameters in interface HttpRequestMetaData

Parameters:

key - the query parameter key.

values - the query parameter values.

Returns:

this.

setQueryParameters

HttpRequest setQueryParameters(String key,
 String... values)

Description copied from interface: HttpRequestMetaData

Sets new query parameters with the specified key and values. This method is equivalent to:

 removeQueryParameter(key);
 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 

Specified by:

setQueryParameters in interface HttpRequestMetaData

Parameters:

key - the query parameter key.

values - the query parameter values.

Returns:

this.

fragment

default HttpRequest fragment(@Nullable
 String fragment)

Description copied from interface: HttpRequestMetaData

Sets the fragment part of the request target.

Specified by:

fragment in interface HttpRequestMetaData

Parameters:

fragment - the fragment to set.

Returns:

this.

version

HttpRequest version(HttpProtocolVersion version)

Description copied from interface: HttpMetaData

Set the protocol version of this HttpMetaData.

Specified by:

version in interface HttpMetaData

Specified by:

version in interface HttpRequestMetaData

Parameters:

version - the protocol version to set.

Returns:

this.

encoding

@Deprecated
default HttpRequest encoding(ContentCodec encoding)

Deprecated.

Description copied from interface: HttpMetaData

The ContentCodec used to encode the payload of a request or a response. If the endpoint is setup with ContentCodingHttpServiceFilter, 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 passing Identity.identity().

Specified by:

encoding in interface HttpMetaData

Parameters:

encoding - The ContentCodec used for the encoding of the payload.

Returns:

this.

See Also:

• Content-Encoding

contentEncoding

HttpRequest contentEncoding(@Nullable
 BufferEncoder encoder)

Description copied from interface: HttpRequestMetaData

Set the BufferEncoder to use for this request. The value can be used by filters (such as ContentEncodingHttpRequesterFilter) to apply HttpHeaderNames.CONTENT_ENCODING to the request.

Specified by:

contentEncoding in interface HttpRequestMetaData

Parameters:

encoder - BufferEncoder to use for this request.

Returns:

this.

method

HttpRequest method(HttpRequestMethod method)

Description copied from interface: HttpRequestMetaData

Set the HttpRequestMethod of this StreamingHttpRequest.

Specified by:

method in interface HttpRequestMetaData

Parameters:

method - the HttpRequestMethod to set.

Returns:

this.

requestTarget

HttpRequest requestTarget(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 as HttpRequestMetaData.path(), HttpRequestMetaData.rawQuery(), etc.

Specified by:

requestTarget in interface HttpRequestMetaData

Parameters:

requestTarget - the percent-encoded request-target to set.

Returns:

this.

requestTarget

HttpRequest requestTarget(String requestTarget,
 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 as HttpRequestMetaData.path(), HttpRequestMetaData.rawQuery(), etc.

Specified by:

requestTarget in interface HttpRequestMetaData

Parameters:

requestTarget - the request-target to set.

encoding - the Charset to use to encode requestTarget before setting the value.

Returns:

this.

addHeader

default HttpRequest addHeader(CharSequence name,
 CharSequence value)

Description copied from interface: HttpMetaData

Adds a new header with the specified name and value.

Specified by:

addHeader in interface HttpMetaData

Specified by:

addHeader in interface HttpRequestMetaData

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 of headers object.

Specified by:

addHeaders in interface HttpMetaData

Specified by:

addHeaders in interface HttpRequestMetaData

Parameters:

headers - the headers to add.

Returns:

this.

setHeader

default HttpRequest setHeader(CharSequence name,
 CharSequence value)

Description copied from interface: HttpMetaData

Sets a header with the specified name and value. Any existing headers with the same name are overwritten.

Specified by:

setHeader in interface HttpMetaData

Specified by:

setHeader in interface HttpRequestMetaData

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 specified headers object.

Specified by:

setHeaders in interface HttpMetaData

Specified by:

setHeaders in interface HttpRequestMetaData

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 HttpCookiePairs with same name.

Specified by:

addCookie in interface HttpMetaData

Specified by:

addCookie in interface HttpRequestMetaData

Parameters:

cookie - the cookie to add.

Returns:

this.

addCookie

default HttpRequest addCookie(CharSequence name,
 CharSequence value)

Description copied from interface: HttpMetaData

Adds a cookie with the specified name and value.

This may result in multiple HttpSetCookies 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 interface HttpMetaData

Specified by:

addCookie in interface HttpRequestMetaData

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 HttpSetCookies with same name.

Specified by:

addSetCookie in interface HttpMetaData

Specified by:

addSetCookie in interface HttpRequestMetaData

Parameters:

cookie - the cookie to add.

Returns:

this.

addSetCookie

default HttpRequest addSetCookie(CharSequence name,
 CharSequence value)

Description copied from interface: HttpMetaData

Adds a set-cookie with the specified name and value.

This may result in multiple HttpSetCookies 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 interface HttpMetaData

Specified by:

addSetCookie in interface HttpRequestMetaData

Parameters:

name - the name of the cookie.

value - the value of the cookie.

Returns:

this.

addTrailer

default HttpRequest addTrailer(CharSequence name,
 CharSequence value)

addTrailers

default HttpRequest addTrailers(HttpHeaders trailers)

setTrailer

default HttpRequest setTrailer(CharSequence name,
 CharSequence value)

setTrailers

default HttpRequest setTrailers(HttpHeaders trailers)

context

HttpRequest context(ContextMap context)

Description copied from interface: HttpMetaData

Sets a context for this HttpMetaData.

Context can be used to associate a state with a request or response message without serializing its state on the wire.

Specified by:

context in interface ContextMapHolder

Specified by:

context in interface HttpMetaData

Specified by:

context in interface HttpRequestMetaData

Parameters:

context - the new context for this HttpMetaData.

Returns:

this.

trailers

HttpHeaders trailers()

Gets the trailers.

Returns:

the trailers.