Package io.servicetalk.http.api

Interface BlockingStreamingHttpResponse

All Superinterfaces:

HttpMetaData, HttpResponseMetaData

public interface BlockingStreamingHttpResponse
extends HttpResponseMetaData

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

Method Summary

Modifier and Type	Method	Description
default BlockingStreamingHttpResponse	addCookie(HttpCookiePair cookie)	Adds a cookie.
default BlockingStreamingHttpResponse	addCookie(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a cookie with the specified name and value.
default BlockingStreamingHttpResponse	addHeader(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a new header with the specified name and value.
default BlockingStreamingHttpResponse	addHeaders(HttpHeaders headers)	Adds all header names and values of headers object.
default BlockingStreamingHttpResponse	addSetCookie(HttpSetCookie cookie)	Adds a set-cookie.
default BlockingStreamingHttpResponse	addSetCookie(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a set-cookie with the specified name and value.
BlockingIterable<Buffer>	payloadBody()	Gets the underlying payload as a Publisher of Buffers.
BlockingStreamingHttpResponse	payloadBody(CloseableIterable<Buffer> payloadBody)	Returns a BlockingStreamingHttpResponse with its underlying payload set to payloadBody.
<T> BlockingStreamingHttpResponse	payloadBody(CloseableIterable<T> payloadBody, HttpSerializer<T> serializer)	Returns a BlockingStreamingHttpResponse with its underlying payload set to the result of serialization.
default <T> BlockingIterable<T>	payloadBody(HttpDeserializer<T> deserializer)	Gets and deserializes the payload body.
BlockingStreamingHttpResponse	payloadBody(java.io.InputStream payloadBody)	Returns a BlockingStreamingHttpResponse with its underlying payload set to payloadBody.
BlockingStreamingHttpResponse	payloadBody(java.lang.Iterable<Buffer> payloadBody)	Returns a BlockingStreamingHttpResponse with its underlying payload set to payloadBody.
<T> BlockingStreamingHttpResponse	payloadBody(java.lang.Iterable<T> payloadBody, HttpSerializer<T> serializer)	Returns a BlockingStreamingHttpResponse with its underlying payload set to the result of serialization.
default java.io.InputStream	payloadBodyInputStream()	Gets the underlying payload as a InputStream.
default BlockingStreamingHttpResponse	setHeader(java.lang.CharSequence name, java.lang.CharSequence value)	Sets a header with the specified name and value.
default BlockingStreamingHttpResponse	setHeaders(HttpHeaders headers)	Clears the current header entries and copies all header entries of the specified headers object.
BlockingStreamingHttpResponse	status(HttpResponseStatus status)	Set the status of this StreamingHttpResponse.
Single<HttpResponse>	toResponse()	Translates this BlockingStreamingHttpResponse to a HttpResponse.
StreamingHttpResponse	toStreamingResponse()	Translates this BlockingStreamingHttpResponse to a StreamingHttpResponse.
<T> BlockingStreamingHttpResponse	transform(TrailersTransformer<T,Buffer> trailersTransformer)	Returns a BlockingStreamingHttpResponse with its underlying payload transformed to Buffers, with access to the trailers.
<T> BlockingStreamingHttpResponse	transformPayloadBody(java.util.function.Function<BlockingIterable<Buffer>,BlockingIterable<T>> transformer, HttpSerializer<T> serializer)	Returns a BlockingStreamingHttpResponse with its underlying payload transformed to the result of serialization.
default <T,R> BlockingStreamingHttpResponse	transformPayloadBody(java.util.function.Function<BlockingIterable<T>,BlockingIterable<R>> transformer, HttpDeserializer<T> deserializer, HttpSerializer<R> serializer)	Returns a BlockingStreamingHttpResponse with its underlying payload transformed to the result of serialization.
BlockingStreamingHttpResponse	transformPayloadBody(java.util.function.UnaryOperator<BlockingIterable<Buffer>> transformer)	Returns a BlockingStreamingHttpResponse with its underlying payload transformed to Buffers.
<T> BlockingStreamingHttpResponse	transformRaw(TrailersTransformer<T,java.lang.Object> trailersTransformer)	Deprecated. Use transform(TrailersTransformer).
BlockingStreamingHttpResponse	transformRawPayloadBody(java.util.function.UnaryOperator<BlockingIterable<?>> transformer)	Deprecated. Use transformPayloadBody(UnaryOperator).
BlockingStreamingHttpResponse	version(HttpProtocolVersion version)	Set the protocol version of this HttpMetaData.

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

encoding, encoding, headers, toString, toString, version

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

status

Method Detail

payloadBody

BlockingIterable<Buffer> payloadBody()

Gets the underlying payload as a Publisher of Buffers.

Returns:

The Publisher of Buffer representation of the underlying payload body.

payloadBodyInputStream

default java.io.InputStream payloadBodyInputStream()

Gets the underlying payload as a InputStream.

Returns:

The InputStream representation of the underlying payload body.

payloadBody

default <T> BlockingIterable<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 BlockingIterable.

Returns:

The results of the deserialization operation.

payloadBody

BlockingStreamingHttpResponse payloadBody(java.lang.Iterable<Buffer> payloadBody)

Returns a BlockingStreamingHttpResponse with its underlying payload set to payloadBody.

A best effort will be made to apply back pressure to the existing payload body which is being replaced. 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 payload body that is being replaced.

Parameters:

payloadBody - The new payload body.

Returns:

this

payloadBody

BlockingStreamingHttpResponse payloadBody(CloseableIterable<Buffer> payloadBody)

Returns a BlockingStreamingHttpResponse with its underlying payload set to payloadBody.

A best effort will be made to apply back pressure to the existing payload body which is being replaced. 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 payload body that is being replaced.

Parameters:

payloadBody - The new payload body.

Returns:

this

payloadBody

BlockingStreamingHttpResponse payloadBody(java.io.InputStream payloadBody)

Returns a BlockingStreamingHttpResponse with its underlying payload set to payloadBody.

A best effort will be made to apply back pressure to the existing payload body which is being replaced. 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 payload body that is being replaced.

Parameters:

payloadBody - The new payload body.

Returns:

this

payloadBody

<T> BlockingStreamingHttpResponse payloadBody(java.lang.Iterable<T> payloadBody,
                                              HttpSerializer<T> serializer)

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

A best effort will be made to apply back pressure to the existing payload body which is being replaced. 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 payload body that is being replaced.

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> BlockingStreamingHttpResponse payloadBody(CloseableIterable<T> payloadBody,
                                              HttpSerializer<T> serializer)

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

A best effort will be made to apply back pressure to the existing payload body which is being replaced. 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 payload body that is being replaced.

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> BlockingStreamingHttpResponse transformPayloadBody(java.util.function.Function<BlockingIterable<Buffer>,BlockingIterable<T>> transformer,
                                                       HttpSerializer<T> serializer)

Returns a BlockingStreamingHttpResponse 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 BlockingIterable and returns the new payload body BlockingIterable prior to serialization. It is assumed the existing payload body BlockingIterable will be transformed/consumed or else no more responses may be processed.

serializer - Used to serialize the payload body.

Returns:

this

transformPayloadBody

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

Returns a BlockingStreamingHttpResponse 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 BlockingIterable and returns the new payload body BlockingIterable prior to serialization. It is assumed the existing payload body BlockingIterable 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

BlockingStreamingHttpResponse transformPayloadBody(java.util.function.UnaryOperator<BlockingIterable<Buffer>> transformer)

Returns a BlockingStreamingHttpResponse with its underlying payload transformed to Buffers.

Parameters:

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

Returns:

this

transformRawPayloadBody

@Deprecated
BlockingStreamingHttpResponse transformRawPayloadBody(java.util.function.UnaryOperator<BlockingIterable<?>> transformer)

Deprecated.

Use transformPayloadBody(UnaryOperator).

Returns a BlockingStreamingHttpResponse with its underlying payload transformed.

Parameters:

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

Returns:

this

transform

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

Returns a BlockingStreamingHttpResponse 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> BlockingStreamingHttpResponse transformRaw(TrailersTransformer<T,java.lang.Object> trailersTransformer)

Deprecated.

Use transform(TrailersTransformer).

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

toResponse

Single<HttpResponse> toResponse()

Translates this BlockingStreamingHttpResponse to a HttpResponse.

Returns:

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

toStreamingResponse

StreamingHttpResponse toStreamingResponse()

Translates this BlockingStreamingHttpResponse to a StreamingHttpResponse.

Returns:

a StreamingHttpResponse representation of this BlockingStreamingHttpResponse.

version

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

status

BlockingStreamingHttpResponse status(HttpResponseStatus status)

Description copied from interface: HttpResponseMetaData

Set the status of this StreamingHttpResponse.

Specified by:

status in interface HttpResponseMetaData

Parameters:

status - The HttpResponseStatus to set.

Returns:

this.

addHeader

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

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

this.

addHeaders

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

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

this.

setHeaders

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

Parameters:

name - the name of the cookie.

value - the value of the cookie.

Returns:

this.

addSetCookie

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

Parameters:

name - the name of the cookie.

value - the value of the cookie.

Returns:

this.