Module io.inverno.mod.web.server
Package io.inverno.mod.web.server

Interface ErrorWebRouteManager<A extends ExchangeContext,B extends ErrorWebRouter<A>>

Type Parameters:
A - the exchange context type
B - the error Web router type
All Superinterfaces:
BaseWebRouteManager<A,ErrorWebExchange<A>,ErrorWebRoute<A>,B>
public interface ErrorWebRouteManager<A extends ExchangeContext,B extends ErrorWebRouter<A>> extends BaseWebRouteManager<A,ErrorWebExchange<A>,ErrorWebRoute<A>,B>

Manages error Web routes in the Web server.

An error Web route manager is obtained from WebServer.routeError(), it allows to specify the criteria an error Web exchange must match to be handled by the error Web exchange handler defined in handler(ExchangeHandler).

When setting the error exchange handler, interceptors defined in an intercepted Web server are applied to the route when criteria are matching.

It is possible to specify multiple values for any given criteria resulting in multiple error Web routes being created in the error Web router. For instance, the following code will result in the creation of two routes: 


 webServer
     .routeError()
         .path("/path/to/resource")
         .error(IllegalArgumentException.class)
         .error(BadRequestException.class)
         .handler(exchange -> {...})
Since:
1.0
Author:
Jeremy Kuhn
See Also:

  • Method Details

    • error

      ErrorWebRouteManager<A,B> error(Class<? extends Throwable> error)

      Specifies the type of errors that must be matched by an error Web exchange to be processed by the route.

      Parameters:
      error - an error type
      Returns:
      the route manager

    • path

      default ErrorWebRouteManager<A,B> path(String path) throws IllegalArgumentException

      Specifies the absolute path that must be matched by an error Web exchange to be processed by the route.

      The specified path can be specified as a parameterized path and include path pattern like ?, *, ** as defined by URIBuilder. Note that this path is only meant to filter routes and as a result path parameters have no use.

      Parameters:
      path - a path
      Returns:
      the route manager
      Throws:
      IllegalArgumentException - if the specified path is not absolute

    • path

      ErrorWebRouteManager<A,B> path(String path, boolean matchTrailingSlash)

      Specifies the absolute path that must be matched with or without trailing slash by an error Web exchange to be processed by the route.

      The specified path can be specified as a parameterized path and include path pattern like ?, *, ** as defined by URIBuilder. Note that this path is only meant to filter routes and as a result path parameters have no use.

      Parameters:
      path - a path
      matchTrailingSlash - true to match path with or without trailing slash, false otherwise
      Returns:
      the route manager
      Throws:
      IllegalArgumentException - if the specified path is not absolute

    • consume

      ErrorWebRouteManager<A,B> consume(String mediaRange)

      Specifies the media range as defined by RFC 7231 Section 5.3.2 defining the content types accepted by an error Web exchange to be processed by the route.

      Parameters:
      mediaRange - a media range (e.g. application/*)
      Returns:
      the route manager

    • produce

      ErrorWebRouteManager<A,B> produce(String mediaType)

      Specifies the media type as defined by RFC 7231 Section 5.3.2 that must be accepted by an error Web exchange to be processed by the route.

      Parameters:
      mediaType - a media type
      Returns:
      the route manager

    • language

      ErrorWebRouteManager<A,B> language(String languageTag)

      Specifies the language tag as defined by RFC 7231 Section 5.3.5 that must be accepted by an error Web exchange to be processed by the route.

      Parameters:
      languageTag - a language tag (e.g. fr-FR)
      Returns:
      the route manager

    • handler

      B handler(ExchangeHandler<? super A,ErrorWebExchange<A>> handler)

      Specifies the error Web exchange handler used to process error Web exchanges matching the criteria specified in the route manager and returns the originating error Web router.

      The error Web route manager is usually obtained from WebServer.routeError() in which case the resulting error Web router is then a WebServer instance.

      Any error Web route interceptor defined in an intercepted Web server and matching the criteria specified in the route manager is applied to the resulting Web routes.

      Parameters:
      handler - an error Web exchange handler
      Returns:
      the originating error Web router