Package io.servicetalk.http.api

Interface BlockingStreamingHttpServerResponse

All Superinterfaces:

ContextMapHolder, HttpMetaData, HttpResponseMetaData

public interface BlockingStreamingHttpServerResponse
extends HttpResponseMetaData

The equivalent of HttpResponse but provides an ability to write the payload to an HttpPayloadWriter.

See Also:

• BlockingStreamingHttpService

Method Summary

Modifier and Type	Method	Description
default BlockingStreamingHttpServerResponse	addCookie(HttpCookiePair cookie)	Adds a cookie.
default BlockingStreamingHttpServerResponse	addCookie(CharSequence name, CharSequence value)	Adds a cookie with the specified name and value.
default BlockingStreamingHttpServerResponse	addHeader(CharSequence name, CharSequence value)	Adds a new header with the specified name and value.
default BlockingStreamingHttpServerResponse	addHeaders(HttpHeaders headers)	Adds all header names and values of headers object.
default BlockingStreamingHttpServerResponse	addSetCookie(HttpSetCookie cookie)	Adds a set-cookie.
default BlockingStreamingHttpServerResponse	addSetCookie(CharSequence name, CharSequence value)	Adds a set-cookie with the specified name and value.
BlockingStreamingHttpServerResponse	context(ContextMap context)	Sets a context for this HttpMetaData.
default BlockingStreamingHttpServerResponse	encoding(ContentCodec encoding)	The ContentCodec used to encode the payload of a request or a response.
HttpPayloadWriter<Buffer>	sendMetaData()	Sends the HttpResponseMetaData and returns an HttpPayloadWriter to continue writing the payload body.
default <T> HttpPayloadWriter<T>	sendMetaData(HttpSerializer<T> serializer)	Deprecated. Use sendMetaData(HttpStreamingSerializer).
<T> HttpPayloadWriter<T>	sendMetaData(HttpStreamingSerializer<T> serializer)	Sends the HttpResponseMetaData to the client and returns an HttpPayloadWriter of type BlockingStreamingHttpServerResponse to continue writing a payload body.
HttpOutputStream	sendMetaDataOutputStream()	Sends the HttpResponseMetaData to the client and returns an OutputStream to continue writing a payload body.
default BlockingStreamingHttpServerResponse	setHeader(CharSequence name, CharSequence value)	Sets a header with the specified name and value.
default BlockingStreamingHttpServerResponse	setHeaders(HttpHeaders headers)	Clears the current header entries and copies all header entries of the specified headers object.
BlockingStreamingHttpServerResponse	status(HttpResponseStatus status)	Set the status of this StreamingHttpResponse.
BlockingStreamingHttpServerResponse	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

sendMetaData

HttpPayloadWriter<Buffer> sendMetaData()

Sends the HttpResponseMetaData and returns an HttpPayloadWriter to continue writing the payload body.

Note: calling any other method on this class after calling this method is not allowed.

Returns:

HttpPayloadWriter to write a payload body

Throws:

IllegalStateException - if one of the sendMetaData* methods has been called on this response

sendMetaData

@Deprecated
default <T> HttpPayloadWriter<T> sendMetaData(HttpSerializer<T> serializer)

Deprecated.

Use sendMetaData(HttpStreamingSerializer).

Sends the HttpResponseMetaData to the client and returns an HttpPayloadWriter of type BlockingStreamingHttpServerResponse to continue writing a payload body. Each element will be serialized using provided serializer.

Note: calling any other method on this class after calling this method is not allowed.

Type Parameters:

T - the type of objects to write

Parameters:

serializer - used to serialize the payload elements

Returns:

HttpPayloadWriter to write a payload body

Throws:

IllegalStateException - if one of the sendMetaData* methods has been called on this response

sendMetaData

<T> HttpPayloadWriter<T> sendMetaData(HttpStreamingSerializer<T> serializer)

Sends the HttpResponseMetaData to the client and returns an HttpPayloadWriter of type BlockingStreamingHttpServerResponse to continue writing a payload body. Each element will be serialized using provided serializer.

Note: calling any other method on this class after calling this method is not allowed.

Type Parameters:

T - the type of objects to write

Parameters:

serializer - used to serialize the payload elements

Returns:

HttpPayloadWriter to write a payload body

Throws:

IllegalStateException - if one of the sendMetaData* methods has been called on this response

sendMetaDataOutputStream

HttpOutputStream sendMetaDataOutputStream()

Sends the HttpResponseMetaData to the client and returns an OutputStream to continue writing a payload body.

Note: calling any other method on this class after calling this method is not allowed.

Returns:

HttpOutputStream to write a payload body

Throws:

IllegalStateException - if one of the sendMetaData* methods has been called on this response

version

BlockingStreamingHttpServerResponse 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

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

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