Package io.servicetalk.http.api

Interface StreamingHttpRequest

All Superinterfaces:

HttpMetaData, HttpRequestMetaData

public interface StreamingHttpRequest
extends HttpRequestMetaData

The equivalent of HttpRequest but provides the payload as a Publisher.

Method Summary

Modifier and Type	Method	Description
default StreamingHttpRequest	addCookie(HttpCookiePair cookie)	Adds a cookie.
default StreamingHttpRequest	addCookie(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a cookie with the specified name and value.
default StreamingHttpRequest	addHeader(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a new header with the specified name and value.
default StreamingHttpRequest	addHeaders(HttpHeaders headers)	Adds all header names and values of headers object.
StreamingHttpRequest	addQueryParameter(java.lang.String key, java.lang.String value)	Adds a new query parameter with the specified key and value, which will be percent-encoded if needed.
StreamingHttpRequest	addQueryParameters(java.lang.String key, java.lang.Iterable<java.lang.String> values)	Adds new query parameters with the specified key and values.
StreamingHttpRequest	addQueryParameters(java.lang.String key, java.lang.String... values)	Adds new query parameters with the specified key and values.
default StreamingHttpRequest	addSetCookie(HttpSetCookie cookie)	Adds a set-cookie.
default StreamingHttpRequest	addSetCookie(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a set-cookie with the specified name and value.
StreamingHttpRequest	appendPathSegments(java.lang.String... segments)	Appends segments to the current HttpRequestMetaData.path(), performing encoding of each segment (including ('/') characters) according to percent-encoding.
StreamingHttpRequest	encoding(ContentCodec encoding)	The ContentCodec used to encode the payload of a request or a response.
Publisher<java.lang.Object>	messageBody()	Get the message-body which contains the payload body concatenated with the trailer (if present).
StreamingHttpRequest	method(HttpRequestMethod method)	Set the HttpRequestMethod of this StreamingHttpRequest.
StreamingHttpRequest	path(java.lang.String path)	Sets the path, performing encoding according to percent-encoding, except for forward-slash ('/') characters.
Publisher<Buffer>	payloadBody()	Gets the underlying payload as a Publisher of Buffers.
StreamingHttpRequest	payloadBody(Publisher<Buffer> payloadBody)	Returns a StreamingHttpRequest with its underlying payload set to payloadBody.
<T> StreamingHttpRequest	payloadBody(Publisher<T> payloadBody, HttpSerializer<T> serializer)	Returns a StreamingHttpRequest with its underlying payload set to the result of serialization.
default <T> Publisher<T>	payloadBody(HttpDeserializer<T> deserializer)	Gets and deserializes the payload body.
Publisher<java.lang.Object>	payloadBodyAndTrailers()	Deprecated. Use messageBody().
StreamingHttpRequest	query(java.lang.String query)	Sets the path, performing encoding according to rfc3986, Query.
StreamingHttpRequest	rawPath(java.lang.String path)	Sets the path to path, without any encoding performed.
StreamingHttpRequest	rawQuery(java.lang.String query)	Sets the query component to query, without any encoding performed.
StreamingHttpRequest	requestTarget(java.lang.String requestTarget)	Set the request-target.
StreamingHttpRequest	requestTarget(java.lang.String requestTarget, java.nio.charset.Charset encoding)	Set the request-target.
default StreamingHttpRequest	setHeader(java.lang.CharSequence name, java.lang.CharSequence value)	Sets a header with the specified name and value.
default StreamingHttpRequest	setHeaders(HttpHeaders headers)	Clears the current header entries and copies all header entries of the specified headers object.
StreamingHttpRequest	setQueryParameter(java.lang.String key, java.lang.String value)	Sets a query parameter with the specified key and value, which will be percent-encoded if needed.
StreamingHttpRequest	setQueryParameters(java.lang.String key, java.lang.Iterable<java.lang.String> values)	Sets new query parameters with the specified key and values.
StreamingHttpRequest	setQueryParameters(java.lang.String key, java.lang.String... values)	Sets new query parameters with the specified key and values.
BlockingStreamingHttpRequest	toBlockingStreamingRequest()	Translate this StreamingHttpRequest to a BlockingStreamingHttpRequest.
Single<HttpRequest>	toRequest()	Translates this StreamingHttpRequest to a HttpRequest.
<T> StreamingHttpRequest	transform(TrailersTransformer<T,Buffer> trailersTransformer)	Returns a StreamingHttpRequest with its underlying payload transformed to Buffers, with access to the trailers.
StreamingHttpRequest	transformMessageBody(java.util.function.UnaryOperator<Publisher<?>> transformer)	Transform the message-body which contains the payload body concatenated with the trailer (if present).
<T> StreamingHttpRequest	transformPayloadBody(java.util.function.Function<Publisher<Buffer>,Publisher<T>> transformer, HttpSerializer<T> serializer)	Returns a StreamingHttpRequest with its underlying payload transformed to the result of serialization.
default <T,R> StreamingHttpRequest	transformPayloadBody(java.util.function.Function<Publisher<T>,Publisher<R>> transformer, HttpDeserializer<T> deserializer, HttpSerializer<R> serializer)	Returns a StreamingHttpRequest with its underlying payload transformed to the result of serialization.
StreamingHttpRequest	transformPayloadBody(java.util.function.UnaryOperator<Publisher<Buffer>> transformer)	Returns a StreamingHttpRequest with its underlying payload transformed to Buffers.
<T> StreamingHttpRequest	transformRaw(TrailersTransformer<T,java.lang.Object> trailersTransformer)	Deprecated. use transform(TrailersTransformer).
StreamingHttpRequest	transformRawPayloadBody(java.util.function.UnaryOperator<Publisher<?>> transformer)	Deprecated. Use transformPayloadBody(UnaryOperator).
StreamingHttpRequest	version(HttpProtocolVersion version)	Set the protocol version of this HttpMetaData.

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

Publisher<Buffer> payloadBody()

Gets the underlying payload as a Publisher of Buffers.

Returns:

A Publisher of Buffers representing the underlying payload body.

payloadBody

default <T> Publisher<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 underlying Publisher.

Returns:

The results of the deserialization operation.

payloadBodyAndTrailers

@Deprecated
Publisher<java.lang.Object> payloadBodyAndTrailers()

Deprecated.

Use messageBody().

Gets a Publisher that combines the raw payload body concatenated with the trailers.

Returns:

a Publisher that combines the raw payload body concatenated with the trailers.

messageBody

Publisher<java.lang.Object> messageBody()

Get the message-body which contains the payload body concatenated with the trailer (if present).

Returns:

a Publisher that represents the message-body which contains the payload body concatenated with the trailer (if present).

payloadBody

StreamingHttpRequest payloadBody(Publisher<Buffer> payloadBody)

Returns a StreamingHttpRequest with its underlying payload set to payloadBody.

A best effort will be made to apply back pressure to the existing Publisher payload body. If this default policy is not sufficient you can use transformPayloadBody(UnaryOperator) for more fine grain control.

This method reserves the right to delay completion/consumption of payloadBody. This may occur due to the combination with the existing Publisher payload body.

Parameters:

payloadBody - The new payload body.

Returns:

this

payloadBody

<T> StreamingHttpRequest payloadBody(Publisher<T> payloadBody,
                                     HttpSerializer<T> serializer)

Returns a StreamingHttpRequest with its underlying payload set to the result of serialization.

A best effort will be made to apply back pressure to the existing Publisher payload body. If this default policy is not sufficient you can use transformPayloadBody(Function, HttpSerializer) for more fine grain control.

This method reserves the right to delay completion/consumption of payloadBody. This may occur due to the combination with the existing Publisher payload body.

Type Parameters:

T - The type of objects to serialize.

Parameters:

payloadBody - The new payload body, prior to serialization.

serializer - Used to serialize the payload body.

Returns:

this

transformPayloadBody

<T> StreamingHttpRequest transformPayloadBody(java.util.function.Function<Publisher<Buffer>,Publisher<T>> transformer,
                                              HttpSerializer<T> serializer)

Returns a StreamingHttpRequest with its underlying payload transformed to the result of serialization.

Type Parameters:

T - The type of objects to serialize.

Parameters:

transformer - A Function which take as a parameter the existing payload body Publisher and returns the new payload body Publisher prior to serialization. It is assumed the existing payload body Publisher will be transformed/consumed or else no more requests may be processed.

serializer - Used to serialize the payload body.

Returns:

this

transformPayloadBody

default <T,R> StreamingHttpRequest transformPayloadBody(java.util.function.Function<Publisher<T>,Publisher<R>> transformer,
                                                              HttpDeserializer<T> deserializer,
                                                              HttpSerializer<R> serializer)

Returns a StreamingHttpRequest with its underlying payload transformed to the result of serialization.

Type Parameters:

T - The type of objects to deserialize.

R - The type of objects to serialize.

Parameters:

transformer - A Function which take as a parameter the existing payload body Publisher and returns the new payload body Publisher prior to serialization. It is assumed the existing payload body Publisher will be transformed/consumed or else no more requests may be processed.

deserializer - Used to deserialize the existing payload body.

serializer - Used to serialize the payload body.

Returns:

this

transformPayloadBody

StreamingHttpRequest transformPayloadBody(java.util.function.UnaryOperator<Publisher<Buffer>> transformer)

Returns a StreamingHttpRequest with its underlying payload transformed to Buffers.

Parameters:

transformer - A UnaryOperator which take as a parameter the existing payload body Publisher and returns the new payload body Publisher. It is assumed the existing payload body Publisher will be transformed/consumed or else no more requests may be processed.

Returns:

this

transformRawPayloadBody

@Deprecated
StreamingHttpRequest transformRawPayloadBody(java.util.function.UnaryOperator<Publisher<?>> transformer)

Deprecated.

Use transformPayloadBody(UnaryOperator).

Returns a StreamingHttpRequest with its underlying payload transformed. Note that the raw objects of the underlying Publisher may be exposed. The object types are not guaranteed to be homogeneous.

Parameters:

transformer - Responsible for transforming the payload body.

Returns:

this

transformMessageBody

StreamingHttpRequest transformMessageBody(java.util.function.UnaryOperator<Publisher<?>> transformer)

Transform the message-body which contains the payload body concatenated with the trailer (if present).

The transformation is not expected to change the presence of trailers in the message body. For example behavior is undefined if a HttpHeaders object is inserted to or removed from to the returned Publisher. To add trailers use transform(TrailersTransformer).

Parameters:

transformer - Responsible for transforming the message-body.

Returns:

this.

transform

<T> StreamingHttpRequest transform(TrailersTransformer<T,Buffer> trailersTransformer)

Returns a StreamingHttpRequest with its underlying payload transformed to Buffers, with access to the trailers.

Type Parameters:

T - The type of state used during the transformation.

Parameters:

trailersTransformer - TrailersTransformer to use for this transform.

Returns:

this

transformRaw

@Deprecated
<T> StreamingHttpRequest transformRaw(TrailersTransformer<T,java.lang.Object> trailersTransformer)

Deprecated.

use transform(TrailersTransformer).

Returns a StreamingHttpRequest with its underlying payload transformed to Objects, with access to the trailers.

Type Parameters:

T - The type of state used during the transformation.

Parameters:

trailersTransformer - TrailersTransformer to use for this transform.

Returns:

this

toRequest

Single<HttpRequest> toRequest()

Translates this StreamingHttpRequest to a HttpRequest.

Returns:

a Single that completes with a HttpRequest representation of this StreamingHttpRequest.

toBlockingStreamingRequest

BlockingStreamingHttpRequest toBlockingStreamingRequest()

Translate this StreamingHttpRequest to a BlockingStreamingHttpRequest.

Returns:

a BlockingStreamingHttpRequest representation of this StreamingHttpRequest.

rawPath

StreamingHttpRequest rawPath(java.lang.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

StreamingHttpRequest 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 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

StreamingHttpRequest appendPathSegments(java.lang.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

StreamingHttpRequest rawQuery(@Nullable
                              java.lang.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

StreamingHttpRequest query(@Nullable
                           java.lang.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

StreamingHttpRequest addQueryParameter(java.lang.String key,
                                       java.lang.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

StreamingHttpRequest addQueryParameters(java.lang.String key,
                                        java.lang.Iterable<java.lang.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

StreamingHttpRequest addQueryParameters(java.lang.String key,
                                        java.lang.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

StreamingHttpRequest setQueryParameter(java.lang.String key,
                                       java.lang.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

StreamingHttpRequest setQueryParameters(java.lang.String key,
                                        java.lang.Iterable<java.lang.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

StreamingHttpRequest setQueryParameters(java.lang.String key,
                                        java.lang.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.

version

StreamingHttpRequest 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.

method

StreamingHttpRequest 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.

encoding

StreamingHttpRequest encoding(ContentCodec encoding)

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 ContentCodings.identity().

Specified by:

encoding in interface HttpMetaData

Parameters:

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

Returns:

this.

See Also:

Content-Encoding

requestTarget

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

Specified by:

requestTarget in interface HttpRequestMetaData

Parameters:

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

Returns:

this.

requestTarget

StreamingHttpRequest 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 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 StreamingHttpRequest addHeader(java.lang.CharSequence name,
                                       java.lang.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 StreamingHttpRequest 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 StreamingHttpRequest setHeader(java.lang.CharSequence name,
                                       java.lang.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 StreamingHttpRequest 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 StreamingHttpRequest 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 StreamingHttpRequest addCookie(java.lang.CharSequence name,
                                       java.lang.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 StreamingHttpRequest 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 StreamingHttpRequest addSetCookie(java.lang.CharSequence name,
                                          java.lang.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.