Interface RoutingResponse

All Superinterfaces:

ServerResponse

All Known Implementing Classes:

ServerResponseBase

public interface RoutingResponse
extends ServerResponse

Routing response of a server.

Method Summary

Modifier and Type	Method	Description
default RoutingResponse	automaticContentEncoding(boolean enabled)	Configure whether the WebServer response layer may automatically encode the response entity using the listener content encoding context.
void	commit()	Commit the response.
default RoutingResponse	contentEncoder(ContentEncoder encoder)	Configure an explicit response content encoder.
default void	entityBeforeSend(Runnable listener)	Register an infrastructure listener associated with the current response entity.
default void	entityStreamFilter(UnaryOperator<OutputStream> filterFunction)	Configure an infrastructure output stream filter associated with the current response entity.
boolean	hasEntity()	Whether this request has an entity.
boolean	isNexted()	Whether this request is nexted (ServerResponse.next() was called).
HttpPrologue	reroutePrologue(HttpPrologue prologue)	A new, rerouted prologue.
boolean	reset()	Return true if the underlying response buffers and headers can be reset and a new response can be sent.
default boolean	resetEntity()	Reset the response entity so an unsent response can be replaced while preserving response metadata unrelated to the entity, such as CORS, cookies, cache controls, and Vary headers.
void	resetRouting()	Reset routing information (nexted, rerouted etc.).
default boolean	resetStream()	Return true if the underlying response buffers can be reset and a new response can be sent.
boolean	shouldReroute()	Should we reroute this exchange.

Methods inherited from interface ServerResponse

beforeSend, beforeTrailers, bytesWritten, contentLength, header, header, header, headers, isResponseHandled, isSent, next, outputStream, reroute, reroute, send, send, send, send, send, sink, status, status, status, streamFilter, streamResult, trailers, whenSent

Modifier and Type	Method	Description
default ServerResponse	beforeSend(Runnable listener)	Executed right before the first byte is written to the socket (including response status and headers).
default ServerResponse	beforeTrailers(Consumer<ServerResponseTrailers> beforeTrailers)	Callback to update any last minute trailers before they are written to the output stream.
long	bytesWritten()	Number of bytes written to response.
default void	contentLength(long length)	Configure a content length header for this response.
ServerResponse	header(Header header)	Set header with a value.
default ServerResponse	header(HeaderName name, String... values)	Set a header.
default ServerResponse	header(String name, String... values)	Not optimized method for setting a header.
ServerResponseHeaders	headers()	Response headers (mutable).
default boolean	isResponseHandled()	Whether this response has already been handled by the application.
boolean	isSent()	Whether this response has been sent.
ServerResponse	next()	Continue processing with the next route (and if none found, return a Status.NOT_FOUND_404).
OutputStream	outputStream()	Alternative way to send an entity, using an output stream.
ServerResponse	reroute(String newPath)	Re-route using a different path.
ServerResponse	reroute(String path, UriQuery query)	Re-route using a different path and query.
void	send()	Send a response with no entity.
void	send(byte[] bytes)	Send a byte array response.
default void	send(byte[] bytes, int position, int length)	Send a byte array response.
void	send(Object entity)	Send an entity, a MediaContext will be used to serialize the entity.
default void	send(Optional<?> entity)	Send an entity if present, throw NotFoundException if empty.
default <T extends Sink<?>> T	sink(GenericType<T> sinkType)	Returns a sink from this response based on the sink type.
Status	status()	Configured HTTP status, if not configured, returns Status.OK_200.
default ServerResponse	status(int status)	Status of the response.
ServerResponse	status(Status status)	Status of the response.
void	streamFilter(UnaryOperator<OutputStream> filterFunction)	Configure a custom output stream to wrap the output stream of the response.
void	streamResult(String result)	Description of the result of output stream processing.
ServerResponseTrailers	trailers()	Response trailers (mutable).
ServerResponse	whenSent(Runnable listener)	Completed when last byte is buffered for socket write.

Method Details

resetRouting

void resetRouting()

Reset routing information (nexted, rerouted etc.).

shouldReroute

boolean shouldReroute()

Should we reroute this exchange.

Returns:

whether rerouting was requested

reroutePrologue

HttpPrologue reroutePrologue(HttpPrologue prologue)

A new, rerouted prologue.

Parameters:

prologue - current prologue

Returns:

prologue to use when rerouting

isNexted

boolean isNexted()

Whether this request is nexted (ServerResponse.next() was called).

Returns:

if nexted

hasEntity

boolean hasEntity()

Whether this request has an entity.

Returns:

whether has entity

automaticContentEncoding

default RoutingResponse automaticContentEncoding(boolean enabled)

Configure whether the WebServer response layer may automatically encode the response entity using the listener content encoding context. This does not remove or rewrite any explicitly configured Content-Encoding header. Repeated calls replace the previous setting until response content encoding is selected.

Specified by:

automaticContentEncoding in interface ServerResponse

Parameters:

enabled - whether automatic response content encoding is enabled

Returns:

this instance

Throws:

IllegalStateException - if response content encoding was already selected, or the response was sent

contentEncoder

default RoutingResponse contentEncoder(ContentEncoder encoder)

Configure an explicit response content encoder. Repeated calls replace the previous encoder until response content encoding is selected. The selected encoder's headers are applied once during selection.

Specified by:

contentEncoder in interface ServerResponse

Parameters:

encoder - content encoder

Returns:

this instance

Throws:

NullPointerException - if encoder is null

IllegalStateException - if response content encoding was already selected, or the response was sent

reset

boolean reset()

Return true if the underlying response buffers and headers can be reset and a new response can be sent.

Returns:

true if reset was successful and a new response can be created instead of the existing one, false if reset failed and status and headers (and maybe entity bytes) were already sent

commit

void commit()

Commit the response. This is mostly useful for output stream based responses, where we may want to delay closing the output stream to handle errors, when route uses try with resources. After this method is called, response cannot be reset().

resetStream

default boolean resetStream()

Return true if the underlying response buffers can be reset and a new response can be sent.

As opposed to reset(), this method is not expected to reset headers already configured on the response

This method calls reset() by default.

Returns:

true if reset was successful and a new response can be created instead of the existing one, false if reset failed and status and headers (and maybe entity bytes) were already sent

resetEntity

default boolean resetEntity()

Reset the response entity so an unsent response can be replaced while preserving response metadata unrelated to the entity, such as CORS, cookies, cache controls, and Vary headers.

This method is intended for Helidon infrastructure that replaces a failed response entity.

Implementations that track entity metadata must override this method to reset entity buffers and remove framing, representation, validator, range, and trailer headers. Implementations with separate trailer state must reset that state as well. This method does not change the response status. An error handler that replaces the entity is responsible for configuring or deliberately retaining an appropriate status before sending the replacement response.

For compatibility with existing RoutingResponse implementations, the default implementation calls resetStream().

Returns:

true if reset was successful and a new entity can be created instead of the existing one, false if reset failed and status and headers (and maybe entity bytes) were already sent

entityStreamFilter

default void entityStreamFilter(UnaryOperator<OutputStream> filterFunction)

Configure an infrastructure output stream filter associated with the current response entity.

Implementations which distinguish entity-scoped filters remove the filter if error handling replaces the unsent entity. Application filters should use ServerResponse.streamFilter(UnaryOperator) so they also apply to a replacement error response. The default fallback registers the filter through the public method and therefore retains it.

Parameters:

filterFunction - function that wraps the response output stream

entityBeforeSend

default void entityBeforeSend(Runnable listener)

Register an infrastructure listener associated with the current response entity.

Implementations which distinguish entity-scoped listeners remove the listener if error handling replaces the unsent entity. Application listeners should use ServerResponse.beforeSend(Runnable) so they also apply to a replacement error response. The default fallback registers the listener through the public method and therefore retains it.

Parameters:

listener - listener invoked before the response is sent