Package io.servicetalk.http.api

Interface HttpResponse

All Superinterfaces:

ContextMapHolder, HttpMetaData, HttpResponseMetaData

public interface HttpResponse
extends HttpResponseMetaData

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

Method Summary

Modifier and Type	Method	Description
default HttpResponse	addCookie(HttpCookiePair cookie)	Adds a cookie.
default HttpResponse	addCookie(CharSequence name, CharSequence value)	Adds a cookie with the specified name and value.
default HttpResponse	addHeader(CharSequence name, CharSequence value)	Adds a new header with the specified name and value.
default HttpResponse	addHeaders(HttpHeaders headers)	Adds all header names and values of headers object.
default HttpResponse	addSetCookie(HttpSetCookie cookie)	Adds a set-cookie.
default HttpResponse	addSetCookie(CharSequence name, CharSequence value)	Adds a set-cookie with the specified name and value.
default HttpResponse	addTrailer(CharSequence name, CharSequence value)
default HttpResponse	addTrailers(HttpHeaders trailers)
HttpResponse	context(ContextMap context)	Sets a context for this HttpMetaData.
default HttpResponse	encoding(ContentCodec encoding)	The ContentCodec used to encode the payload of a request or a response.
Buffer	payloadBody()	Gets the underlying payload as a Buffer.
HttpResponse	payloadBody(Buffer payloadBody)	Returns an HttpResponse 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> HttpResponse	payloadBody(T pojo, HttpSerializer<T> serializer)	Deprecated. Use payloadBody(Object, HttpSerializer2).
<T> HttpResponse	payloadBody(T pojo, HttpSerializer2<T> serializer)	Returns an HttpResponse with its underlying payload set to the results of serialization of pojo.
default HttpResponse	setHeader(CharSequence name, CharSequence value)	Sets a header with the specified name and value.
default HttpResponse	setHeaders(HttpHeaders headers)	Clears the current header entries and copies all header entries of the specified headers object.
default HttpResponse	setTrailer(CharSequence name, CharSequence value)
default HttpResponse	setTrailers(HttpHeaders trailers)
HttpResponse	status(HttpResponseStatus status)	Set the status of this StreamingHttpResponse.
BlockingStreamingHttpResponse	toBlockingStreamingResponse()	Translates this HttpResponse to a BlockingStreamingHttpResponse.
StreamingHttpResponse	toStreamingResponse()	Translates this HttpResponse to a StreamingHttpResponse.
HttpHeaders	trailers()	Gets the trailers.
HttpResponse	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

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

HttpResponse payloadBody(Buffer payloadBody)

Returns an HttpResponse with its underlying payload set to payloadBody.

Parameters:

payloadBody - the underlying payload.

Returns:

this

payloadBody

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

Deprecated.

Use payloadBody(Object, HttpSerializer2).

Returns an HttpResponse 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> HttpResponse payloadBody(T pojo,
 HttpSerializer2<T> serializer)

Returns an HttpResponse 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

toStreamingResponse

StreamingHttpResponse toStreamingResponse()

Translates this HttpResponse to a StreamingHttpResponse.

Returns:

a StreamingHttpResponse representation of this HttpResponse.

toBlockingStreamingResponse

BlockingStreamingHttpResponse toBlockingStreamingResponse()

Translates this HttpResponse to a BlockingStreamingHttpResponse.

Returns:

a BlockingStreamingHttpResponse representation of this HttpResponse.

version

HttpResponse 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

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

encoding

default HttpResponse 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 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 HttpResponse 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 HttpResponse 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 HttpResponse 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 HttpResponse 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 HttpResponse 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 HttpResponse 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 HttpResponse 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 HttpResponse 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.

addTrailer

default HttpResponse addTrailer(CharSequence name,
 CharSequence value)

addTrailers

default HttpResponse addTrailers(HttpHeaders trailers)

setTrailer

default HttpResponse setTrailer(CharSequence name,
 CharSequence value)

setTrailers

default HttpResponse setTrailers(HttpHeaders trailers)

context

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

trailers

HttpHeaders trailers()

Gets the trailers.

Returns:

the trailers.