Module io.inverno.mod.web.server

Package io.inverno.mod.web.server

Interface WebRoutable<A extends ExchangeContext,B extends WebRoutable<A,B>>

Type Parameters:

A - the type of the exchange context

B - the Web routable type

All Superinterfaces:

Routable<A,WebExchange<A>,B,WebRouteManager<A,B>,WebRoute<A>>

All Known Subinterfaces:

WebInterceptedRouter<A>, WebRouter<A>

public interface WebRoutable<A extends ExchangeContext,B extends WebRoutable<A,B>>
extends Routable<A,WebExchange<A>,B,WebRouteManager<A,B>,WebRoute<A>>

A web routable allows to defined Web routes.

Since:

1.3

Author:

Jeremy Kuhn

See Also:

• WebRouter

Method Summary

Modifier and Type	Method	Description
B	configureRoutes(WebRoutesConfigurer<? super A> configurer)	Configures web routes using the specified configurer and returns the web routable.
default B	configureRoutes(List<WebRoutesConfigurer<? super A>> configurers)	Configures web routes using the specified configurers and returns the web routable.
WebSocketRouteManager<A,B>	webSocketRoute()	Returns a WebSocket route manager to define, enable, disable, remove or find WebSocket routes in the router.
default B	webSocketRoute(Consumer<WebSocketRouteManager<A,B>> webSocketRouteConfigurer)	Invokes the specified WebSocket route configurer on a WebSocket route manager.

Methods inherited from interface io.inverno.mod.web.server.spi.Routable

getRoutes, route, route

Method Details

webSocketRoute

WebSocketRouteManager<A,B> webSocketRoute()

Returns a WebSocket route manager to define, enable, disable, remove or find WebSocket routes in the router.

Returns:

a WebSocket route manager

webSocketRoute

default B webSocketRoute(Consumer<WebSocketRouteManager<A,B>> webSocketRouteConfigurer)

Invokes the specified WebSocket route configurer on a WebSocket route manager.

Parameters:

webSocketRouteConfigurer - a WebSocket route configurer

Returns:

the router

configureRoutes

B configureRoutes(WebRoutesConfigurer<? super A> configurer)

Configures web routes using the specified configurer and returns the web routable.

If the specified configurer is null this method is a noop.

Parameters:

configurer - a web routes configurer

Returns:

the web routable

configureRoutes

default B configureRoutes(List<WebRoutesConfigurer<? super A>> configurers)

Configures web routes using the specified configurers and returns the web routable.

If the specified list of configurers is null or empty this method is a noop.

Parameters:

configurers - a list of web routes configurers

Returns:

the web routable