Module io.helidon.webserver

Package io.helidon.webserver

Class Routing.Builder

java.lang.Object

io.helidon.webserver.Routing.Builder

All Implemented Interfaces:

Builder<Routing>, Routing.Rules, Supplier<Routing>

Enclosing interface:

Routing

public static class Routing.Builder
extends Object
implements Routing.Rules, Builder<Routing>

A Routing builder.

Method Summary

Modifier and Type	Method	Description
Routing.Builder	any(Handler... requestHandlers)	Routes all requests to provided handler(s).
Routing.Builder	any(PathMatcher pathMatcher, Handler... requestHandlers)	Routes all requests with corresponding path to provided handler(s).
Routing.Builder	any(String pathPattern, Handler... requestHandlers)	Routes all requests with corresponding path to provided handler(s).
Routing.Builder	anyOf(Iterable<Http.RequestMethod> methods, Handler... requestHandlers)	Routes requests any specified method to provided handler(s).
Routing.Builder	anyOf(Iterable<Http.RequestMethod> methods, PathMatcher pathMatcher, Handler... requestHandlers)	Routes requests with any specified method and corresponding path to provided handler(s).
Routing.Builder	anyOf(Iterable<Http.RequestMethod> methods, String pathPattern, Handler... requestHandlers)	Routes requests with any specified method and corresponding path to provided handler(s).
Routing	build()	Builds a new routing instance.
WebServer	createServer()	Deprecated. since 2.0.0, please use WebServer.create(Routing).
WebServer	createServer(ServerConfiguration configuration)	Deprecated. since 2.0.0, please use WebServer.Builder.build() to create a new server, configuring routing using WebServer.Builder.routing(Routing).
WebServer	createServer(ServerConfiguration.Builder configurationBuilder)	Deprecated. since 2.0.0, please use WebServer.Builder.build() to create a new server, configuring routing using WebServer.Builder.routing(Routing).
Routing.Builder	delete(Handler... requestHandlers)	Routes all DELETE requests to provided handler(s).
Routing.Builder	delete(PathMatcher pathMatcher, Handler... requestHandlers)	Routes DELETE requests with corresponding path to provided handler(s).
Routing.Builder	delete(String pathPattern, Handler... requestHandlers)	Routes DELETE requests with corresponding path to provided handler(s).
<T extends Throwable> Routing.Builder	error(Class<T> exceptionClass, ErrorHandler<T> errorHandler)	Registers an error handler that handles the given type of exceptions.
Routing.Builder	get(Handler... requestHandlers)	Routes all GET requests to provided handler(s).
Routing.Builder	get(PathMatcher pathMatcher, Handler... requestHandlers)	Routes GET requests with corresponding path to provided handler(s).
Routing.Builder	get(String pathPattern, Handler... requestHandlers)	Routes GET requests with corresponding path to provided handler(s).
Routing.Builder	head(Handler... requestHandlers)	Routes all HEAD requests to provided handler(s).
Routing.Builder	head(PathMatcher pathMatcher, Handler... requestHandlers)	Routes HEAD requests with corresponding path to provided handler(s).
Routing.Builder	head(String pathPattern, Handler... requestHandlers)	Routes HEAD requests with corresponding path to provided handler(s).
Routing.Builder	onNewWebServer(Consumer<WebServer> webServerConsumer)	Registers callback on created new WebServer instance with this routing.
Routing.Builder	options(Handler... requestHandlers)	Routes all OPTIONS requests to provided handler(s).
Routing.Builder	options(PathMatcher pathMatcher, Handler... requestHandlers)	Routes OPTIONS requests with corresponding path to provided handler(s).
Routing.Builder	options(String pathPattern, Handler... requestHandlers)	Routes OPTIONS requests with corresponding path to provided handler(s).
Routing.Builder	patch(Handler... requestHandlers)	Routes all RFC 5789 PATCH requests to provided handler(s).
Routing.Builder	patch(PathMatcher pathMatcher, Handler... requestHandlers)	Routes RFC 5789 PATCH requests with corresponding path to provided handler(s).
Routing.Builder	patch(String pathPattern, Handler... requestHandlers)	Routes RFC 5789 PATCH requests with corresponding path to provided handler(s).
Routing.Builder	post(Handler... requestHandlers)	Routes all POST requests to provided handler(s).
Routing.Builder	post(PathMatcher pathMatcher, Handler... requestHandlers)	Routes POST requests with corresponding path to provided handler(s).
Routing.Builder	post(String pathPattern, Handler... requestHandlers)	Routes POST requests with corresponding path to provided handler(s).
Routing.Builder	put(Handler... requestHandlers)	Routes all PUT requests to provided handler(s).
Routing.Builder	put(PathMatcher pathMatcher, Handler... requestHandlers)	Routes PUT requests with corresponding path to provided handler(s).
Routing.Builder	put(String pathPattern, Handler... requestHandlers)	Routes PUT requests with corresponding path to provided handler(s).
Routing.Builder	register(Service... services)	Registers builder consumer.
Routing.Builder	register(WebTracingConfig webTracingConfig)	Configuration of tracing for this routing.
Routing.Builder	register(String pathPattern, Service... services)	Registers builder consumer.
Routing.Builder	register(String pathPattern, Supplier<? extends Service>... serviceBuilders)	Registers builder consumer.
Routing.Builder	register(Supplier<? extends Service>... serviceBuilders)	Registers builder consumer.
Routing.Builder	trace(Handler... requestHandlers)	Routes all TRACE requests to provided handler(s).
Routing.Builder	trace(PathMatcher pathMatcher, Handler... requestHandlers)	Routes TRACE requests with corresponding path to provided handler(s).
Routing.Builder	trace(String pathPattern, Handler... requestHandlers)	Routes TRACE requests with corresponding path to provided handler(s).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

register

public Routing.Builder register(WebTracingConfig webTracingConfig)

Description copied from interface: Routing.Rules

Configuration of tracing for this routing. The configuration may control whether to log specific components, spans and span logs, either globally, or for a specific path and method combinations.

Specified by:

register in interface Routing.Rules

Parameters:

webTracingConfig - WebServer tracing configuration

Returns:

Updated routing configuration

register

public Routing.Builder register(Supplier<? extends Service>... serviceBuilders)

Description copied from interface: Routing.Rules

Registers builder consumer. It enables to separate complex routing definitions to dedicated classes.

Specified by:

register in interface Routing.Rules

Parameters:

serviceBuilders - service builder to register; they will be built as a first step of this method execution

Returns:

Updated routing configuration

register

public Routing.Builder register(Service... services)

Description copied from interface: Routing.Rules

Registers builder consumer. It enables to separate complex routing definitions to dedicated classes.

Specified by:

register in interface Routing.Rules

Parameters:

services - services to register

Returns:

Updated routing configuration

register

public Routing.Builder register(String pathPattern,
                                Service... services)

Description copied from interface: Routing.Rules

Registers builder consumer. It enables to separate complex routing definitions to dedicated classes.

Specified by:

register in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

services - services to register

Returns:

Updated routing configuration

register

public Routing.Builder register(String pathPattern,
                                Supplier<? extends Service>... serviceBuilders)

Description copied from interface: Routing.Rules

Registers builder consumer. It enables to separate complex routing definitions to dedicated classes.

Specified by:

register in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

serviceBuilders - service builder to register; they will be built as a first step of this method execution

Returns:

an updated routing configuration

get

public Routing.Builder get(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all GET requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

get in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

get

public Routing.Builder get(String pathPattern,
                           Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes GET requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

get in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

get

public Routing.Builder get(PathMatcher pathMatcher,
                           Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes GET requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

get in interface Routing.Rules

Parameters:

pathMatcher - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

put

public Routing.Builder put(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all PUT requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

put in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

put

public Routing.Builder put(String pathPattern,
                           Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes PUT requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

put in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

put

public Routing.Builder put(PathMatcher pathMatcher,
                           Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes PUT requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

put in interface Routing.Rules

Parameters:

pathMatcher - define path for a registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

post

public Routing.Builder post(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all POST requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

post in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

post

public Routing.Builder post(String pathPattern,
                            Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes POST requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

post in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

post

public Routing.Builder post(PathMatcher pathMatcher,
                            Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes POST requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

post in interface Routing.Rules

Parameters:

pathMatcher - define path for registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

patch

public Routing.Builder patch(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all RFC 5789 PATCH requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

patch in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

patch

public Routing.Builder patch(String pathPattern,
                             Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes RFC 5789 PATCH requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

patch in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

patch

public Routing.Builder patch(PathMatcher pathMatcher,
                             Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes RFC 5789 PATCH requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

patch in interface Routing.Rules

Parameters:

pathMatcher - define path for registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

delete

public Routing.Builder delete(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all DELETE requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

delete in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

delete

public Routing.Builder delete(String pathPattern,
                              Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes DELETE requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

delete in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

delete

public Routing.Builder delete(PathMatcher pathMatcher,
                              Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes DELETE requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

delete in interface Routing.Rules

Parameters:

pathMatcher - define path for registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

options

public Routing.Builder options(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all OPTIONS requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

options in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

options

public Routing.Builder options(String pathPattern,
                               Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes OPTIONS requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

options in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

options

public Routing.Builder options(PathMatcher pathMatcher,
                               Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes OPTIONS requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

options in interface Routing.Rules

Parameters:

pathMatcher - define path for registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

head

public Routing.Builder head(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all HEAD requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

head in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

head

public Routing.Builder head(String pathPattern,
                            Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes HEAD requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

head in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

head

public Routing.Builder head(PathMatcher pathMatcher,
                            Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes HEAD requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

head in interface Routing.Rules

Parameters:

pathMatcher - define path for registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

trace

public Routing.Builder trace(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all TRACE requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

trace in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

trace

public Routing.Builder trace(String pathPattern,
                             Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes TRACE requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

trace in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

trace

public Routing.Builder trace(PathMatcher pathMatcher,
                             Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes TRACE requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

trace in interface Routing.Rules

Parameters:

pathMatcher - define path for registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

any

public Routing.Builder any(Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

any in interface Routing.Rules

Parameters:

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

any

public Routing.Builder any(String pathPattern,
                           Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

any in interface Routing.Rules

Parameters:

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

any

public Routing.Builder any(PathMatcher pathMatcher,
                           Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes all requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

any in interface Routing.Rules

Parameters:

pathMatcher - define path for registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

anyOf

public Routing.Builder anyOf(Iterable<Http.RequestMethod> methods,
                             Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes requests any specified method to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

anyOf in interface Routing.Rules

Parameters:

methods - HTTP methods

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

anyOf

public Routing.Builder anyOf(Iterable<Http.RequestMethod> methods,
                             String pathPattern,
                             Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes requests with any specified method and corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

anyOf in interface Routing.Rules

Parameters:

methods - HTTP methods

pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

anyOf

public Routing.Builder anyOf(Iterable<Http.RequestMethod> methods,
                             PathMatcher pathMatcher,
                             Handler... requestHandlers)

Description copied from interface: Routing.Rules

Routes requests with any specified method and corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.

Specified by:

anyOf in interface Routing.Rules

Parameters:

methods - HTTP methods

pathMatcher - define path for registered router

requestHandlers - handlers to process HTTP request

Returns:

an updated routing configuration

onNewWebServer

public Routing.Builder onNewWebServer(Consumer<WebServer> webServerConsumer)

Description copied from interface: Routing.Rules

Registers callback on created new WebServer instance with this routing.

Specified by:

onNewWebServer in interface Routing.Rules

Parameters:

webServerConsumer - a WebServer creation callback

Returns:

updated routing configuration

error

public <T extends Throwable> Routing.Builder error(Class<T> exceptionClass,
                                                   ErrorHandler<T> errorHandler)

Registers an error handler that handles the given type of exceptions.

Type Parameters:

T - an error handler type

Parameters:

exceptionClass - the type of exception to handle by this handler

errorHandler - the error handler

Returns:

an updated builder

build

public Routing build()

Builds a new routing instance.

Specified by:

build in interface Builder<Routing>

Returns:

a new instance

createServer

@Deprecated
public WebServer createServer(ServerConfiguration configuration)

Deprecated.

since 2.0.0, please use WebServer.Builder.build() to create a new server, configuring routing using WebServer.Builder.routing(Routing).

Creates new WebServer instance with provided configuration and this routing.

Parameters:

configuration - a web server configuration

Returns:

new WebServer instance

Throws:

IllegalStateException - if none SPI implementation found

createServer

@Deprecated
public WebServer createServer(ServerConfiguration.Builder configurationBuilder)

Deprecated.

since 2.0.0, please use WebServer.Builder.build() to create a new server, configuring routing using WebServer.Builder.routing(Routing).

Creates new WebServer instance with provided configuration and this routing.

Parameters:

configurationBuilder - a web server configuration builder

Returns:

new WebServer instance

Throws:

IllegalStateException - if none SPI implementation found

createServer

@Deprecated
public WebServer createServer()

Deprecated.

since 2.0.0, please use WebServer.create(Routing).

Creates new WebServer instance with this routing and default configuration.

Returns:

new WebServer instance

Throws:

IllegalStateException - if none SPI implementation found