Package io.servicetalk.http.api

Interface StreamingHttpResponse

All Superinterfaces:

ContextMapHolder, HttpMetaData, HttpResponseMetaData

public interface StreamingHttpResponse
extends HttpResponseMetaData

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

Method Summary

Modifier and Type	Method	Description
default StreamingHttpResponse	addCookie(HttpCookiePair cookie)	Adds a cookie.
default StreamingHttpResponse	addCookie(CharSequence name, CharSequence value)	Adds a cookie with the specified name and value.
default StreamingHttpResponse	addHeader(CharSequence name, CharSequence value)	Adds a new header with the specified name and value.
default StreamingHttpResponse	addHeaders(HttpHeaders headers)	Adds all header names and values of headers object.
default StreamingHttpResponse	addSetCookie(HttpSetCookie cookie)	Adds a set-cookie.
default StreamingHttpResponse	addSetCookie(CharSequence name, CharSequence value)	Adds a set-cookie with the specified name and value.
StreamingHttpResponse	context(ContextMap context)	Sets a context for this HttpMetaData.
default StreamingHttpResponse	encoding(ContentCodec encoding)	Deprecated.
Publisher<Object>	messageBody()	Get the message-body which contains the payload body concatenated with the trailer (if present).
Publisher<Buffer>	payloadBody()	Gets the underlying payload as a Publisher of Buffers.
StreamingHttpResponse	payloadBody(Publisher<Buffer> payloadBody)	Returns a StreamingHttpResponse with its underlying payload set to payloadBody.
default <T> StreamingHttpResponse	payloadBody(Publisher<T> payloadBody, HttpSerializer<T> serializer)	Deprecated. Use payloadBody(Publisher, HttpStreamingSerializer).
<T> StreamingHttpResponse	payloadBody(Publisher<T> payloadBody, HttpStreamingSerializer<T> serializer)	Returns a StreamingHttpResponse with its underlying payload set to the result of serialization.
default <T> Publisher<T>	payloadBody(HttpDeserializer<T> deserializer)	Deprecated. Use payloadBody(HttpStreamingDeserializer).
<T> Publisher<T>	payloadBody(HttpStreamingDeserializer<T> deserializer)	Gets and deserializes the payload body.
default StreamingHttpResponse	setHeader(CharSequence name, CharSequence value)	Sets a header with the specified name and value.
default StreamingHttpResponse	setHeaders(HttpHeaders headers)	Clears the current header entries and copies all header entries of the specified headers object.
BlockingStreamingHttpResponse	toBlockingStreamingResponse()	Translates this StreamingHttpResponse to a BlockingStreamingHttpResponse.
Single<HttpResponse>	toResponse()	Translates this StreamingHttpResponse to a HttpResponse.
<T> StreamingHttpResponse	transform(TrailersTransformer<T,Buffer> trailersTransformer)	Returns a StreamingHttpResponse with its underlying payload transformed to Buffers, with access to the trailers.
<T, S> StreamingHttpResponse	transform(TrailersTransformer<T,S> trailersTransformer, HttpStreamingDeserializer<S> deserializer)	Returns a StreamingHttpResponse with its underlying payload transformed to StreamingHttpResponses, with access to the trailers.
StreamingHttpResponse	transformMessageBody(UnaryOperator<Publisher<?>> transformer)	Transform the message-body which contains the payload body concatenated with the trailer (if present).
default <T> StreamingHttpResponse	transformPayloadBody(Function<Publisher<Buffer>,Publisher<T>> transformer, HttpSerializer<T> serializer)	Deprecated. Use transformPayloadBody(Function, HttpStreamingSerializer).
<T> StreamingHttpResponse	transformPayloadBody(Function<Publisher<Buffer>,Publisher<T>> transformer, HttpStreamingSerializer<T> serializer)	Returns a StreamingHttpResponse with its underlying payload transformed to the result of serialization.
default <T, R> StreamingHttpResponse	transformPayloadBody(Function<Publisher<T>,Publisher<R>> transformer, HttpDeserializer<T> deserializer, HttpSerializer<R> serializer)	Deprecated. Use transformPayloadBody(Function, HttpStreamingDeserializer, HttpStreamingSerializer).
<T, R> StreamingHttpResponse	transformPayloadBody(Function<Publisher<T>,Publisher<R>> transformer, HttpStreamingDeserializer<T> deserializer, HttpStreamingSerializer<R> serializer)	Returns a StreamingHttpResponse with its underlying payload transformed to the result of serialization.
StreamingHttpResponse	transformPayloadBody(UnaryOperator<Publisher<Buffer>> transformer)	Returns a StreamingHttpResponse with its underlying payload transformed to Buffers.
StreamingHttpResponse	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.HttpResponseMetaData

status, status

Method Details

payloadBody

Publisher<Buffer> payloadBody()

Gets the underlying payload as a Publisher of Buffers.

Returns:

A Publisher of Buffers representing the underlying payload body.

payloadBody

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

Deprecated.

Use payloadBody(HttpStreamingDeserializer).

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.

payloadBody

<T> Publisher<T> payloadBody(HttpStreamingDeserializer<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.

messageBody

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

StreamingHttpResponse payloadBody(Publisher<Buffer> payloadBody)

Returns a StreamingHttpResponse 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

@Deprecated
default <T> StreamingHttpResponse payloadBody(Publisher<T> payloadBody,
 HttpSerializer<T> serializer)

Deprecated.

Use payloadBody(Publisher, HttpStreamingSerializer).

Returns a StreamingHttpResponse 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

payloadBody

<T> StreamingHttpResponse payloadBody(Publisher<T> payloadBody,
 HttpStreamingSerializer<T> serializer)

Returns a StreamingHttpResponse 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, HttpStreamingSerializer) 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

@Deprecated
default <T> StreamingHttpResponse transformPayloadBody(Function<Publisher<Buffer>,Publisher<T>> transformer,
 HttpSerializer<T> serializer)

Deprecated.

Use transformPayloadBody(Function, HttpStreamingSerializer).

Returns a StreamingHttpResponse 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 responses may be processed.

serializer - Used to serialize the payload body.

Returns:

this

transformPayloadBody

<T> StreamingHttpResponse transformPayloadBody(Function<Publisher<Buffer>,Publisher<T>> transformer,
 HttpStreamingSerializer<T> serializer)

Returns a StreamingHttpResponse 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 responses may be processed.

serializer - Used to serialize the payload body.

Returns:

this

transformPayloadBody

@Deprecated
default <T,
R> StreamingHttpResponse transformPayloadBody(Function<Publisher<T>,Publisher<R>> transformer,
 HttpDeserializer<T> deserializer,
 HttpSerializer<R> serializer)

Deprecated.

Use transformPayloadBody(Function, HttpStreamingDeserializer, HttpStreamingSerializer).

Returns a StreamingHttpResponse 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

<T,
R> StreamingHttpResponse transformPayloadBody(Function<Publisher<T>,Publisher<R>> transformer,
 HttpStreamingDeserializer<T> deserializer,
 HttpStreamingSerializer<R> serializer)

Returns a StreamingHttpResponse 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

StreamingHttpResponse transformPayloadBody(UnaryOperator<Publisher<Buffer>> transformer)

Returns a StreamingHttpResponse with its underlying payload transformed to Buffers.

Parameters:

transformer - A Function 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 responses may be processed.

Returns:

this

transformMessageBody

StreamingHttpResponse transformMessageBody(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 content of the message body Publisher or presence of trailers in it. For example, behavior is undefined if a content is altered (added/removed/resized) or trailers are inserted to or removed from to the returned Publisher. To alter the payload body content use transformPayloadBody(UnaryOperator) method, its overloads, or transform(TrailersTransformer) method which can also be used to modify trailers.

Parameters:

transformer - Responsible for transforming the message-body.

Returns:

this.

transform

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

Returns a StreamingHttpResponse 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

transform

<T,
S> StreamingHttpResponse transform(TrailersTransformer<T,S> trailersTransformer,
 HttpStreamingDeserializer<S> deserializer)

Returns a StreamingHttpResponse with its underlying payload transformed to StreamingHttpResponses, with access to the trailers.

Type Parameters:

T - The type of state used during the transformation.

S - The type of objects to deserialize.

Parameters:

trailersTransformer - TrailersTransformer to use for this transform.

deserializer - Used to deserialize the existing payload body.

Returns:

this

toResponse

Single<HttpResponse> toResponse()

Translates this StreamingHttpResponse to a HttpResponse.

Returns:

a Single that completes with a HttpResponse representation of this StreamingHttpResponse.

toBlockingStreamingResponse

BlockingStreamingHttpResponse toBlockingStreamingResponse()

Translates this StreamingHttpResponse to a BlockingStreamingHttpResponse.

Returns:

a BlockingStreamingHttpResponse representation of this StreamingHttpResponse.

version

StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

version - the protocol version to set.

Returns:

this.

encoding

@Deprecated
default StreamingHttpResponse 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

addHeader

default StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

this.

addHeaders

default StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

headers - the headers to add.

Returns:

this.

setHeader

default StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

this.

setHeaders

default StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

headers - the headers object which contains new values.

Returns:

this.

addCookie

default StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

cookie - the cookie to add.

Returns:

this.

addCookie

default StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

name - the name of the cookie.

value - the value of the cookie.

Returns:

this.

addSetCookie

default StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

cookie - the cookie to add.

Returns:

this.

addSetCookie

default StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

name - the name of the cookie.

value - the value of the cookie.

Returns:

this.

context

StreamingHttpResponse 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 HttpResponseMetaData

Parameters:

context - the new context for this HttpMetaData.

Returns:

this.