reactor.netty.http.server

Interface HttpServerRoutes

All Superinterfaces:

java.util.function.BiFunction<HttpServerRequest,HttpServerResponse,Publisher<Void>>

public interface HttpServerRoutes
extends java.util.function.BiFunction<HttpServerRequest,HttpServerResponse,Publisher<Void>>

Server routes are unique and only the first matching in order of declaration will be invoked.

Author:

Stephane Maldini

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Predicate<HttpServerRequest>	INDEX_PREDICATE

Method Summary

Modifier and Type	Method and Description
default HttpServerRoutes	delete(String path, java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) Listens for HTTP DELETE on the passed path to be used as a routing condition.
default HttpServerRoutes	directory(String uri, Path directory) Listens for HTTP GET on the passed path to be used as a routing condition.
HttpServerRoutes	directory(String uri, Path directory, java.util.function.Function<HttpServerResponse,HttpServerResponse> interceptor) Listens for HTTP GET on the passed path to be used as a routing condition.The content of the provided directory will be served.
default HttpServerRoutes	file(java.util.function.Predicate<HttpServerRequest> uri, Path path, java.util.function.Function<HttpServerResponse,HttpServerResponse> interceptor) Listens for HTTP GET on the passed path to be used as a routing condition.
default HttpServerRoutes	file(String uri, Path path) Listens for HTTP GET on the passed path to be used as a routing condition.
default HttpServerRoutes	file(String uri, String path) Listens for HTTP GET on the passed path to be used as a routing condition.
default HttpServerRoutes	get(String path, java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) Listens for HTTP GET on the passed path to be used as a routing condition.
default HttpServerRoutes	head(String path, java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) Listens for HTTP HEAD on the passed path to be used as a routing condition.
default HttpServerRoutes	index(java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) This route will be invoked when GET "/path" or "/path/" like uri are requested.
static HttpServerRoutes	newRoutes() Returns a new default routing registry HttpServerRoutes
default HttpServerRoutes	options(String path, java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) Listens for HTTP OPTIONS on the passed path to be used as a routing condition.
default HttpServerRoutes	post(String path, java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) Listens for HTTP POST on the passed path to be used as a routing condition.
default HttpServerRoutes	put(String path, java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) Listens for HTTP PUT on the passed path to be used as a routing condition.
HttpServerRoutes	route(java.util.function.Predicate<? super HttpServerRequest> condition, java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) A generic route predicate that if matched invoke the passed I/O handler.
default HttpServerRoutes	ws(java.util.function.Predicate<? super HttpServerRequest> condition, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> handler, String protocols) Listens for websocket with the given route predicate to invoke the matching I/O handler.
default HttpServerRoutes	ws(java.util.function.Predicate<? super HttpServerRequest> condition, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> handler, String protocols, int maxFramePayloadLength) Listens for websocket with the given route predicate to invoke the matching handler.
default HttpServerRoutes	ws(String path, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> handler) Listens for websocket on the passed path to be used as a routing condition.
default HttpServerRoutes	ws(String path, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> handler, String protocols) Listens for websocket on the passed path to be used as a routing condition.

Methods inherited from interface java.util.function.BiFunction

andThen, apply

Field Detail

INDEX_PREDICATE

static final java.util.function.Predicate<HttpServerRequest> INDEX_PREDICATE

Method Detail

newRoutes

static HttpServerRoutes newRoutes()

Returns a new default routing registry HttpServerRoutes

Returns:

a new default routing registry HttpServerRoutes

delete

default HttpServerRoutes delete(String path,
                                java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

Listens for HTTP DELETE on the passed path to be used as a routing condition. Incoming connections will query the internal registry to invoke the matching handler.

Additional regex matching is available, e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

path - The DELETE path used by clients.

handler - an I/O handler to invoke for the given condition

Returns:

this HttpServerRoutes

directory

default HttpServerRoutes directory(String uri,
                                   Path directory)

Listens for HTTP GET on the passed path to be used as a routing condition. The content of the provided directory will be served.

Additional regex matching is available, e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

uri - The GET path used by clients

directory - the root prefix to serve from the file system, e.g. "/Users/me/resources"

Returns:

this HttpServerRoutes

directory

HttpServerRoutes directory(String uri,
                           Path directory,
                           @Nullable
                           java.util.function.Function<HttpServerResponse,HttpServerResponse> interceptor)

Listens for HTTP GET on the passed path to be used as a routing condition.The content of the provided directory will be served.

Additional regex matching is available, e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

uri - The GET path used by clients

directory - the root prefix to serve from the file system, e.g. "/Users/me/resources"

interceptor - a pre response processor

Returns:

this HttpServerRoutes

file

default HttpServerRoutes file(String uri,
                              Path path)

Listens for HTTP GET on the passed path to be used as a routing condition. The provided File will be served.

Additional regex matching is available, e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

uri - The GET path used by clients

path - the resource Path to serve

Returns:

this HttpServerRoutes

file

default HttpServerRoutes file(String uri,
                              String path)

Listens for HTTP GET on the passed path to be used as a routing condition. The file at provided path will be served.

Additional regex matching is available, e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

uri - The GET path used by clients

path - the resource path to serve

Returns:

this HttpServerRoutes

file

default HttpServerRoutes file(java.util.function.Predicate<HttpServerRequest> uri,
                              Path path,
                              @Nullable
                              java.util.function.Function<HttpServerResponse,HttpServerResponse> interceptor)

Listens for HTTP GET on the passed path to be used as a routing condition. The file on the provided Path is served.

Additional regex matching is available e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

uri - The HttpPredicate to use to trigger the route, pattern matching and capture are supported

path - the Path to the file to serve

interceptor - a channel pre-intercepting handler e.g. for content type header

Returns:

this HttpServerRoutes

get

default HttpServerRoutes get(String path,
                             java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

Listens for HTTP GET on the passed path to be used as a routing condition. Incoming connections will query the internal registry to invoke the matching handler.

Additional regex matching is available e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

path - The GET path used by clients

handler - an I/O handler to invoke for the given condition

Returns:

this HttpServerRoutes

head

default HttpServerRoutes head(String path,
                              java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

Listens for HTTP HEAD on the passed path to be used as a routing condition. Incoming connections will query the internal registry to invoke the matching handler.

Additional regex matching is available e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

path - The HEAD path used by clients

handler - an I/O handler to invoke for the given condition

Returns:

this HttpServerRoutes

index

default HttpServerRoutes index(java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

This route will be invoked when GET "/path" or "/path/" like uri are requested.

Parameters:

handler - an I/O handler to invoke on index/root request

Returns:

this HttpServerRoutes

options

default HttpServerRoutes options(String path,
                                 java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

Listens for HTTP OPTIONS on the passed path to be used as a routing condition. Incoming connections will query the internal registry to invoke the matching handler.

Additional regex matching is available e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

path - The OPTIONS path used by clients

handler - an I/O handler to invoke for the given condition

Returns:

this HttpServerRoutes

post

default HttpServerRoutes post(String path,
                              java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

Listens for HTTP POST on the passed path to be used as a routing condition. Incoming connections will query the internal registry to invoke the matching handler.

Additional regex matching is available e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

path - The POST path used by clients

handler - an I/O handler to invoke for the given condition

Returns:

this HttpServerRoutes

put

default HttpServerRoutes put(String path,
                             java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

Listens for HTTP PUT on the passed path to be used as a routing condition. Incoming connections will query the internal registry to invoke the matching handler.

Additional regex matching is available e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence)

Parameters:

path - The PUT path used by clients

handler - an I/O handler to invoke for the given condition

Returns:

this HttpServerRoutes

route

HttpServerRoutes route(java.util.function.Predicate<? super HttpServerRequest> condition,
                       java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

A generic route predicate that if matched invoke the passed I/O handler.

Parameters:

condition - a predicate given each inbound request

handler - the I/O handler to invoke on match

Returns:

this HttpServerRoutes

ws

default HttpServerRoutes ws(String path,
                            java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> handler)

Listens for websocket on the passed path to be used as a routing condition. Incoming connections will query the internal registry to invoke the matching handler.

Additional regex matching is available e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence) They are NOT accessible in the I/O handler provided as parameter.

Parameters:

path - The websocket path used by clients

handler - an I/O handler to invoke for the given condition

Returns:

this HttpServerRoutes

ws

default HttpServerRoutes ws(String path,
                            java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> handler,
                            @Nullable
                            String protocols)

Listens for websocket on the passed path to be used as a routing condition. Incoming connections will query the internal registry to invoke the matching handler.

Additional regex matching is available e.g. "/test/{param}". Params are resolved using HttpServerRequest.param(CharSequence) They are NOT accessible in the handler provided as parameter.

Parameters:

path - The websocket path used by clients

handler - an I/O handler to invoke for the given condition

protocols - sub-protocol to use in websocket handshake signature

Returns:

this HttpServerRoutes

ws

default HttpServerRoutes ws(java.util.function.Predicate<? super HttpServerRequest> condition,
                            java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> handler,
                            @Nullable
                            String protocols)

Listens for websocket with the given route predicate to invoke the matching I/O handler.

Parameters:

condition - a predicate given each inbound request

handler - an I/O handler to invoke for the given condition

protocols - sub-protocol to use in websocket handshake signature

Returns:

this HttpServerRoutes

ws

default HttpServerRoutes ws(java.util.function.Predicate<? super HttpServerRequest> condition,
                            java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> handler,
                            @Nullable
                            String protocols,
                            int maxFramePayloadLength)

Listens for websocket with the given route predicate to invoke the matching handler.

Parameters:

condition - a predicate given each inbound request

handler - an I/O handler to invoke for the given condition

protocols - sub-protocol to use in webspcket handshake signature

maxFramePayloadLength - specifies a custom maximum allowable frame payload length

Returns:

this HttpServerRoutes