Package io.servicetalk.http.api

Interface HttpResponseMetaData

All Superinterfaces:

HttpMetaData

All Known Subinterfaces:

BlockingStreamingHttpResponse, HttpResponse, StreamingHttpResponse

All Known Implementing Classes:

BlockingStreamingHttpServerResponse

public interface HttpResponseMetaData
extends HttpMetaData

Meta data associated with an HTTP response. This includes pieces form the status line and other meta data from HttpMetaData.

Method Summary

Modifier and Type	Method	Description
default HttpResponseMetaData	addCookie(HttpCookiePair cookie)	Adds a cookie.
default HttpResponseMetaData	addCookie(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a cookie with the specified name and value.
default HttpResponseMetaData	addHeader(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a new header with the specified name and value.
default HttpResponseMetaData	addHeaders(HttpHeaders headers)	Adds all header names and values of headers object.
default HttpResponseMetaData	addSetCookie(HttpSetCookie cookie)	Adds a set-cookie.
default HttpResponseMetaData	addSetCookie(java.lang.CharSequence name, java.lang.CharSequence value)	Adds a set-cookie with the specified name and value.
default HttpResponseMetaData	setHeader(java.lang.CharSequence name, java.lang.CharSequence value)	Sets a header with the specified name and value.
default HttpResponseMetaData	setHeaders(HttpHeaders headers)	Clears the current header entries and copies all header entries of the specified headers object.
HttpResponseStatus	status()	Returns the status of this StreamingHttpResponse.
HttpResponseMetaData	status(HttpResponseStatus status)	Set the status of this StreamingHttpResponse.
HttpResponseMetaData	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

Method Detail

status

HttpResponseStatus status()

Returns the status of this StreamingHttpResponse.

Returns:

The HttpResponseStatus of this StreamingHttpResponse

status

HttpResponseMetaData status(HttpResponseStatus status)

Set the status of this StreamingHttpResponse.

Parameters:

status - The HttpResponseStatus to set.

Returns:

this.

version

HttpResponseMetaData version(HttpProtocolVersion version)

Description copied from interface: HttpMetaData

Set the protocol version of this HttpMetaData.

Specified by:

version in interface HttpMetaData

Parameters:

version - the protocol version to set.

Returns:

this.

addHeader

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

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

this.

addHeaders

default HttpResponseMetaData addHeaders(HttpHeaders headers)

Description copied from interface: HttpMetaData

Adds all header names and values of headers object.

Specified by:

addHeaders in interface HttpMetaData

Parameters:

headers - the headers to add.

Returns:

this.

setHeader

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

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

this.

setHeaders

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

Parameters:

headers - the headers object which contains new values.

Returns:

this.

addCookie

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

Parameters:

cookie - the cookie to add.

Returns:

this.

addCookie

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

Parameters:

name - the name of the cookie.

value - the value of the cookie.

Returns:

this.

addSetCookie

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

Parameters:

cookie - the cookie to add.

Returns:

this.

addSetCookie

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

Parameters:

name - the name of the cookie.

value - the value of the cookie.

Returns:

this.