Module io.inverno.mod.web.server

Package io.inverno.mod.web.server

Interface WebResponse

All Superinterfaces:

BaseResponse, Response

public interface WebResponse
extends Response

A response with supports for body encoding based on the response content type.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• WebExchange

Method Summary

Modifier and Type	Method	Description
WebResponseBody	body()	Returns the response body used to produce response payload.
WebResponse	headers(Consumer<OutboundResponseHeaders> headersConfigurer)	Configures the HTTP headers to send in the response.
WebResponse	sendContinue()	Sends an interim 100 continue response to the client so it can send the rest of the request.
WebResponse	trailers(Consumer<OutboundHeaders<?>> trailersConfigurer)	Configures the HTTP trailers to send in the response.

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

headers, trailers

Methods inherited from interface io.inverno.mod.http.server.Response

getTransferredLength, isHeadersWritten

Method Details

headers

WebResponse headers(Consumer<OutboundResponseHeaders> headersConfigurer)
             throws IllegalStateException

Description copied from interface: Response

Configures the HTTP headers to send in the response.

Specified by:

headers in interface Response

Parameters:

headersConfigurer - a response headers configurer

Returns:

the response

Throws:

IllegalStateException - if response headers have already been sent to the client

sendContinue

WebResponse sendContinue()
                  throws IllegalStateException

Description copied from interface: Response

Sends an interim 100 continue response to the client so it can send the rest of the request.

This method should only be used when the request contains header expect: 100-continue.

Specified by:

sendContinue in interface Response

Returns:

the response

Throws:

IllegalStateException - if response headers have already been sent to the client

body

WebResponseBody body()

Description copied from interface: Response

Returns the response body used to produce response payload.

Specified by:

body in interface Response

Returns:

a response body

trailers

WebResponse trailers(Consumer<OutboundHeaders<?>> trailersConfigurer)

Description copied from interface: Response

Configures the HTTP trailers to send in the response.

Specified by:

trailers in interface Response

Parameters:

trailersConfigurer - a response trailers configurer

Returns:

the response