Package io.micronaut.web.router

Class RouteAttributes

java.lang.Object
io.micronaut.web.router.RouteAttributes
public final class RouteAttributes extends Object
Accessors for various route- and server-related attributes.
Since:
4.8.0
Author:
Jonas Konrad

  • Method Details

    • getRouteMatch

      public static @NonNull Optional<RouteMatch<?>> getRouteMatch(@NonNull HttpRequest<?> request)
      Get the route match.
      Parameters:
      request - The request
      Returns:
      The route match, if present

    • setRouteMatch

      public static void setRouteMatch(@NonNull HttpRequest<?> request, @NonNull RouteMatch<?> routeMatch)
      Set the route match.
      Parameters:
      request - The request
      routeMatch - The route match

    • getRouteMatch

      public static @NonNull Optional<RouteMatch<?>> getRouteMatch(@NonNull HttpResponse<?> response)
      Get the route match.
      Parameters:
      response - The response
      Returns:
      The route match, if present

    • setRouteMatch

      public static void setRouteMatch(@NonNull HttpResponse<?> response, @NonNull RouteMatch<?> routeMatch)
      Set the route match.
      Parameters:
      response - The response
      routeMatch - The route match

    • getRouteInfo

      public static @NonNull Optional<RouteInfo<?>> getRouteInfo(@NonNull HttpRequest<?> request)
      Get the route info.
      Parameters:
      request - The request
      Returns:
      The route info, if present

    • setRouteInfo

      public static void setRouteInfo(@NonNull HttpRequest<?> request, @NonNull RouteInfo<?> routeInfo)
      Set the route info.
      Parameters:
      request - The request
      routeInfo - The route info

    • getRouteInfo

      public static @NonNull Optional<RouteInfo<?>> getRouteInfo(@NonNull HttpResponse<?> response)
      Get the route info.
      Parameters:
      response - The response
      Returns:
      The route info, if present

    • setRouteInfo

      public static void setRouteInfo(@NonNull HttpResponse<?> response, @NonNull RouteInfo<?> routeInfo)
      Set the route info.
      Parameters:
      response - The response
      routeInfo - The route info

    • getException

      public static @NonNull Optional<Throwable> getException(@NonNull HttpResponse<?> response)
      Get the exception that triggered this response.
      Parameters:
      response - The response
      Returns:
      The exception, if present

    • setException

      public static void setException(@NonNull HttpResponse<?> response, @NonNull Throwable throwable)
      Set the exception that triggered this response.
      Parameters:
      response - The response
      throwable - The exception

    • getHeadBody

      public static @NonNull Optional<Object> getHeadBody(@NonNull HttpResponse<?> response)
      Get the body that was discarded because this is a response to a HEAD request.
      Parameters:
      response - The response
      Returns:
      The discarded body, if present

    • setHeadBody

      public static void setHeadBody(@NonNull HttpResponse<?> response, @NonNull Object body)
      Set the body that was discarded because this is a response to a HEAD request.
      Parameters:
      response - The response
      body - The body