Interface WebServer.Intercepted<A extends ExchangeContext>
- Type Parameters:
A
- the exchange context type
- All Superinterfaces:
BaseWebRouter
,ErrorWebRouteInterceptor<A>
,ErrorWebRouter<A>
,WebRouteInterceptor<A>
,WebRouter<A>
,WebServer<A>
- Enclosing interface:
WebServer<A extends ExchangeContext>
An intercepted Web server applies interceptors when defining Web routes or error Web routes when their criteria are matching interceptor definitions.
Intercepted Web servers are returned by WebRouteInterceptor
or ErrorWebRouteInterceptor
after defining interceptors resulting in trees of intercepted Web server where each node
can apply all previously defined interceptors.
When defining a route, the intercepted Web server resolves all interceptors matching the route's criteria and applies them to the route handler. When the set of exchanges matched by the route is bigger than the set of exchanges matched by the interceptor definition, the exchange interceptor is wrapped to order to filter exchanges that exactly match the interceptor's criteria.
- Since:
- 1.12
- Author:
- Jeremy Kuhn
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.inverno.mod.web.server.WebServer
WebServer.Boot, WebServer.Configurer<A extends ExchangeContext>, WebServer.Intercepted<A extends ExchangeContext>
-
Method Summary
Modifier and TypeMethodDescriptionconfigure
(WebServer.Configurer<? super A> configurer) Configures the Web server.configure
(List<WebServer.Configurer<? super A>> configurers) Configures the Web server.configureErrorRoutes
(ErrorWebRouter.Configurer<? super A> configurer) Configures multiple error Web routes and returns the originating error Web router.configureErrorRoutes
(List<ErrorWebRouter.Configurer<? super A>> configurers) Configures multiple error Web routes and returns the originating error Web router.configureRoutes
(WebRouter.Configurer<? super A> configurer) Configures multiple Web routes or WebSocket routes and returns the originating Web router.configureRoutes
(List<WebRouter.Configurer<? super A>> configurers) Configures multiple Web routes or WebSocket routes and returns the originating Web router.route()
Returns a new route manager for defining a Web route.default WebServer.Intercepted
<A> Configures a Web route and returns the originating Web router.Returns a new route manager for defining an error Web route.default WebServer.Intercepted
<A> routeError
(Consumer<ErrorWebRouteManager<A, ? extends ErrorWebRouter<A>>> configurer) Configures an error Web route and returns the originating error Web router.unwrap()
Returns the originating Web server.Returns a new route manager for defining a WebSocket route.default WebServer.Intercepted
<A> webSocketRoute
(Consumer<WebSocketRouteManager<A, ? extends WebRouter<A>>> configurer) Configures a WebSocket route and returns the originating Web router.Methods inherited from interface io.inverno.mod.web.server.WebServer
configureErrorInterceptors, configureErrorInterceptors, configureInterceptors, configureInterceptors, getErrorRoutes, getRoutes, getWebSocketRoutes, intercept, intercept, interceptError, interceptError
-
Method Details
-
route
WebRouteManager<A,WebServer.Intercepted<A>> route()Description copied from interface:WebRouter
Returns a new route manager for defining a Web route.
- Specified by:
route
in interfaceWebRouter<A extends ExchangeContext>
- Specified by:
route
in interfaceWebServer<A extends ExchangeContext>
- Returns:
- a new Web route manager
-
route
default WebServer.Intercepted<A> route(Consumer<WebRouteManager<A, ? extends WebRouter<A>>> configurer) Description copied from interface:WebRouter
Configures a Web route and returns the originating Web router.
- Specified by:
route
in interfaceWebRouter<A extends ExchangeContext>
- Specified by:
route
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurer
- a Web route configurer function- Returns:
- the originating Web router
-
webSocketRoute
WebSocketRouteManager<A,WebServer.Intercepted<A>> webSocketRoute()Description copied from interface:WebRouter
Returns a new route manager for defining a WebSocket route.
- Specified by:
webSocketRoute
in interfaceWebRouter<A extends ExchangeContext>
- Specified by:
webSocketRoute
in interfaceWebServer<A extends ExchangeContext>
- Returns:
- a new WebSocket route manager
-
webSocketRoute
default WebServer.Intercepted<A> webSocketRoute(Consumer<WebSocketRouteManager<A, ? extends WebRouter<A>>> configurer) Description copied from interface:WebRouter
Configures a WebSocket route and returns the originating Web router.
- Specified by:
webSocketRoute
in interfaceWebRouter<A extends ExchangeContext>
- Specified by:
webSocketRoute
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurer
- a WebSocket route configurer function- Returns:
- the originating Web router
-
configureRoutes
Description copied from interface:WebRouter
Configures multiple Web routes or WebSocket routes and returns the originating Web router.
- Specified by:
configureRoutes
in interfaceWebRouter<A extends ExchangeContext>
- Specified by:
configureRoutes
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurer
- a Web route configurer- Returns:
- the originating Web router
-
configureRoutes
Description copied from interface:WebRouter
Configures multiple Web routes or WebSocket routes and returns the originating Web router.
- Specified by:
configureRoutes
in interfaceWebRouter<A extends ExchangeContext>
- Specified by:
configureRoutes
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurers
- a list of Web route configurers- Returns:
- the originating Web router
-
routeError
ErrorWebRouteManager<A,WebServer.Intercepted<A>> routeError()Description copied from interface:ErrorWebRouter
Returns a new route manager for defining an error Web route.
- Specified by:
routeError
in interfaceErrorWebRouter<A extends ExchangeContext>
- Specified by:
routeError
in interfaceWebServer<A extends ExchangeContext>
- Returns:
- a new error Web route manager
-
routeError
default WebServer.Intercepted<A> routeError(Consumer<ErrorWebRouteManager<A, ? extends ErrorWebRouter<A>>> configurer) Description copied from interface:ErrorWebRouter
Configures an error Web route and returns the originating error Web router.
- Specified by:
routeError
in interfaceErrorWebRouter<A extends ExchangeContext>
- Specified by:
routeError
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurer
- an error Web route configurer function- Returns:
- the originating error Web router
-
configureErrorRoutes
Description copied from interface:ErrorWebRouter
Configures multiple error Web routes and returns the originating error Web router.
- Specified by:
configureErrorRoutes
in interfaceErrorWebRouter<A extends ExchangeContext>
- Specified by:
configureErrorRoutes
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurer
- an error Web route configurer- Returns:
- the originating error Web router
-
configureErrorRoutes
WebServer.Intercepted<A> configureErrorRoutes(List<ErrorWebRouter.Configurer<? super A>> configurers) Description copied from interface:ErrorWebRouter
Configures multiple error Web routes and returns the originating error Web router.
- Specified by:
configureErrorRoutes
in interfaceErrorWebRouter<A extends ExchangeContext>
- Specified by:
configureErrorRoutes
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurers
- a list of error Web route configurers- Returns:
- the originating error Web router
-
configure
Description copied from interface:WebServer
Configures the Web server.
The resulting Web server can be the originating Web server or an intercepted Web server depending on whether interceptors are defined in the configurer and the intercepted Web server thus obtained is returned by the configurer.
- Specified by:
configure
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurer
- A Web server configurer- Returns:
- a Web server
-
configure
Description copied from interface:WebServer
Configures the Web server.
The resulting Web server can be the originating Web server or an intercepted Web server depending on whether interceptors are defined in the configurers and the intercepted Web server thus obtained is returned by the last configurer.
- Specified by:
configure
in interfaceWebServer<A extends ExchangeContext>
- Parameters:
configurers
- A Web server configurer- Returns:
- a Web server
-
unwrap
Returns the originating Web server.
Since intercepted Web servers are defined in a hierarchical way, the returned Web server can be an intercepted Web server.
- Returns:
- an intercepted Web server or the root Web server
-