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

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

Type Parameters:
A - the type of the exchange context
B - the Error Web routable type
All Superinterfaces:
ErrorRouteManager<A,ErrorWebExchange<A>,B,ErrorWebRouteManager<A,B>,ErrorWebRoute<A>>, RouteManager<A,ErrorWebExchange<A>,B,ErrorWebRouteManager<A,B>,ErrorWebRoute<A>>
public interface ErrorWebRouteManager<A extends ExchangeContext,B extends ErrorWebRoutable<A,B>> extends ErrorRouteManager<A,ErrorWebExchange<A>,B,ErrorWebRouteManager<A,B>,ErrorWebRoute<A>>

An error web route manager is used to manage the routes of an error web router. It is created by an error web router and allows to define, enable, disable, remove and find error web routes in an error web router.

Since:
1.0
Author:
Jeremy Kuhn
See Also:

  • Method Details

    • path

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

      Specifies the path to the resource served by the error web route without matching trailing slash.

      The specified path can be a parameterized path including path parameters as defined by URIBuilder.

      Parameters:
      path - the path to the resource
      Returns:
      the error web route manager
      Throws:
      IllegalArgumentException - if the specified path is not absolute
      See Also:

    • path

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

      Specifies the path to the resource served by the error web route matching or not trailing slash.

      The specified path can be a parameterized path including path parameters as defined by URIBuilder.

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

    • consumes

      ErrorWebRouteManager<A,B> consumes(String mediaRange)

      Specifies the media range defining the content types accepted by the resource served by the web route as defined by RFC 7231 Section 5.3.2.

      Parameters:
      mediaRange - a media range
      Returns:
      the web route manager
      See Also:

    • produces

      ErrorWebRouteManager<A,B> produces(String mediaType)

      Specifies the media type of the resource served by the error web route.

      Parameters:
      mediaType - a media type
      Returns:
      the error web route manager
      See Also:

    • language

      ErrorWebRouteManager<A,B> language(String language)

      Specifies the language of the resource served by the error web route.

      Parameters:
      language - a language tag
      Returns:
      the error web route manager
      See Also: