Module io.helidon.webserver

Package io.helidon.webserver

Interface Handler

All Superinterfaces:

BiConsumer<ServerRequest,ServerResponse>

All Known Subinterfaces:

AccessLogEntry

All Known Implementing Classes:

AbstractLogEntry, CorsSupport, HeaderLogEntry, HostLogEntry, JsonService, RequestLineLogEntry, RequestPredicate.ConditionalHandler, SecurityHandler, SizeLogEntry, StatusLogEntry, TimestampLogEntry, TimeTakenLogEntry, UserIdLogEntry, UserLogEntry

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Handler
extends BiConsumer<ServerRequest,ServerResponse>

The ServerRequest and ServerResponse handler. Can be mapped to the routing rules in the Routing.

See Also:

• Routing.Builder
• Routing.Rules

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Handler.EntityHandler<T>	Handles request, response and HTTP request content entity.

Method Summary

Modifier and Type	Method	Description
void	accept(ServerRequest req, ServerResponse res)	Handles request and response usually called from the Routing.
static <T> Handler	create(Class<T> entityType, Handler.EntityHandler<T> entityHandler)	Creates new instance of the Handler for the entity representing HTTP request content.
static <T> Handler	create(Class<T> entityType, Handler.EntityHandler<T> entityHandler, ErrorHandler<Throwable> entityReadErrorHandler)	Creates new instance of the Handler for the entity representing HTTP request content.

Methods inherited from interface java.util.function.BiConsumer

andThen

Method Details

accept

void accept(ServerRequest req,
 ServerResponse res)

Handles request and response usually called from the Routing.

Specified by:

accept in interface BiConsumer<ServerRequest,ServerResponse>

Parameters:

req - an HTTP server request.

res - an HTTP server response.

create

static <T> Handler create(Class<T> entityType,
 Handler.EntityHandler<T> entityHandler)

Creates new instance of the Handler for the entity representing HTTP request content. See ServerRequest for more details how response can be represented as a java type.

Created handler forwards any error created during entity read or conversion to the standard error handling (ServerRequest.next(Throwable)).

Type Parameters:

T - a type of the entity

Parameters:

entityType - a java type of the entity

entityHandler - an entity handler to handle request entity

Returns:

new Handler instance

create

static <T> Handler create(Class<T> entityType,
 Handler.EntityHandler<T> entityHandler,
 ErrorHandler<Throwable> entityReadErrorHandler)

Creates new instance of the Handler for the entity representing HTTP request content. See ServerRequest for more details how response can be represented as a java type.

Type Parameters:

T - a type of the entity

Parameters:

entityType - a java type of the entity

entityHandler - an entity handler to handle request entity

entityReadErrorHandler - an error handler to handle state when entity cannot be read or convert to the requested type

Returns:

new Handler instance