Module io.inverno.mod.http.base

Package io.inverno.mod.http.base

Interface OutboundResponseHeaders

All Superinterfaces:

InboundHeaders, InboundResponseHeaders, OutboundHeaders<OutboundResponseHeaders>

public interface OutboundResponseHeaders
extends InboundResponseHeaders, OutboundHeaders<OutboundResponseHeaders>

Represents mutable outbound HTTP response headers.

This extends the OutboundHeaders to expose response specific information like response status, content type, content length and set-cookies.

An outbound response is sent by a server in a server exchange.

Since:

1.6

Author:

Jeremy Kuhn

Method Summary

Modifier and Type	Method	Description
OutboundResponseHeaders	contentLength(long contentLength)	Sets the response content length.
OutboundResponseHeaders	contentType(String contentType)	Sets the response content type header field value.
OutboundResponseHeaders	cookies(Consumer<OutboundSetCookies> cookiesConfigurer)	Sets the response set-cookies.
OutboundResponseHeaders	status(int status)	Sets the response HTTP status code
OutboundResponseHeaders	status(Status status)	Sets the response HTTP status.

Methods inherited from interface io.inverno.mod.http.base.InboundHeaders

contains, contains, get, getAll, getAll, getAllHeader, getAllHeader, getAllParameter, getAllParameter, getHeader, getNames, getParameter

Methods inherited from interface io.inverno.mod.http.base.InboundResponseHeaders

cookies, getContentLength, getContentType, getContentTypeHeader, getStatus, getStatusCode

Methods inherited from interface io.inverno.mod.http.base.OutboundHeaders

add, add, isWritten, remove, set, set

Method Details

status

OutboundResponseHeaders status(Status status)

Sets the response HTTP status.

Parameters:

status - the HTTP status

Returns:

the response headers

status

OutboundResponseHeaders status(int status)

Sets the response HTTP status code

Parameters:

status - the HTTP status code

Returns:

the response headers

contentType

OutboundResponseHeaders contentType(String contentType)

Sets the response content type header field value.

Parameters:

contentType - the content type

Returns:

the response headers

contentLength

OutboundResponseHeaders contentLength(long contentLength)

Sets the response content length.

Parameters:

contentLength - the content length

Returns:

the response headers

cookies

OutboundResponseHeaders cookies(Consumer<OutboundSetCookies> cookiesConfigurer)

Sets the response set-cookies.

Parameters:

cookiesConfigurer - an outbound set-cookies configurer

Returns:

the response headers