Interface HttpRoute

All Superinterfaces:

Route, ServerLifecycle

All Known Implementing Classes:

Http1Route, Http2Route

public interface HttpRoute
extends Route

A basic HTTP route (should be usable by ANY HTTP protocol version).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HttpRoute.Builder	Fluent API builder for HttpRoute.

Method Summary

Modifier and Type	Method	Description
PathMatchers.MatchResult	accepts(HttpPrologue prologue)	Whether this route accept the provided request.
default PathMatchers.MatchResult	accepts(HttpPrologue prologue, ServerRequestHeaders headers)	Whether this route accept the provided request.
static HttpRoute.Builder	builder()	Builder to build a new HTTP route.
Handler	handler()	Handler of this route.
default Optional<PathMatcher>	pathMatcher()	Path matcher for this HTTP route.

Methods inherited from interface ServerLifecycle

afterStart, afterStop, beforeStart

Modifier and Type	Method	Description
default void	afterStart(WebServer webServer)	After server start.
default void	afterStop()	After server stop.
default void	beforeStart()	Before server start.

Method Details

builder

static HttpRoute.Builder builder()

Builder to build a new HTTP route.

Returns:

builder

accepts

PathMatchers.MatchResult accepts(HttpPrologue prologue)

Whether this route accept the provided request.

Parameters:

prologue - prologue of the request

Returns:

result of the validation

See Also:

• PathMatchers.MatchResult.notAccepted()

accepts

default PathMatchers.MatchResult accepts(HttpPrologue prologue,
 ServerRequestHeaders headers)

Whether this route accept the provided request.

Parameters:

prologue - prologue of the request

headers - headers of the request

Returns:

result of the validation

See Also:

• PathMatchers.MatchResult.notAccepted()

handler

Handler handler()

Handler of this route.

Returns:

handler

pathMatcher

default Optional<PathMatcher> pathMatcher()

Path matcher for this HTTP route.

Returns:

optional path matcher