Package io.micronaut.servlet.http

Interface ServletExchange<Req,Res>

Type Parameters:

Req - The native request type

Res - The native response type

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ApacheServletHttpRequest, DefaultServletExchange, DefaultServletHttpRequest, PojaHttpRequest

public interface ServletExchange<Req,Res>
extends Closeable

Represents an HTTP exchange in a serverless context.

Since:

2.0.0

Author:

graemerocher

Method Summary

Modifier and Type	Method	Description
default void	close()
default @NonNull ServletHttpResponse<Res,?>	createResponse()	Create a new, empty response for this exchange.
ServletHttpRequest<Req,? super Object>	getRequest()
@NonNull ServletHttpResponse<Res,?>	getResponse()	Get the current response, the last response created by createResponse().

Method Details

getRequest

ServletHttpRequest<Req,? super Object> getRequest()

Returns:

The request object

getResponse

@NonNull
@NonNull ServletHttpResponse<Res,?> getResponse()

Get the current response, the last response created by createResponse().

Returns:

The response object

createResponse

@NonNull
default @NonNull ServletHttpResponse<Res,?> createResponse()

Create a new, empty response for this exchange. Only the last response created for a request is fully backed by the servlet container response, meaning it can access ServletHttpResponse.getOutputStream() and similar methods.

Returns:

The response

Since:

5.1.0

close

default void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable