Package io.quarkus.vertx.http.deployment

Class RouteBuildItem.Builder

java.lang.Object
io.quarkus.vertx.http.deployment.RouteBuildItem.Builder
Direct Known Subclasses:
HttpRootPathBuildItem.Builder, NonApplicationRootPathBuildItem.Builder
Enclosing class:
RouteBuildItem
public static class RouteBuildItem.Builder extends Object
HttpRootPathBuildItem.Builder and NonApplicationRootPathBuildItem.Builder extend this. Please verify the extended builders behavior when changing this one.

  • Field Details

    • routeFunction

      protected Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route> routeFunction

    • handler

      protected io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler

    • type

      protected io.quarkus.vertx.http.runtime.HandlerType type

    • displayOnNotFoundPage

      protected boolean displayOnNotFoundPage

    • notFoundPageTitle

      protected String notFoundPageTitle

    • notFoundPagePath

      protected String notFoundPagePath

    • routePath

      protected String routePath

    • routeConfigKey

      protected String routeConfigKey

    • absolutePath

      protected String absolutePath

    • isManagement

      protected boolean isManagement

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • routeFunction

      @Deprecated public RouteBuildItem.Builder routeFunction(Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route> routeFunction)
      Deprecated.
      routeFunction(String, Consumer) should be used instead
      Parameters:
      routeFunction -
      See Also:

    • routeFunction

      public RouteBuildItem.Builder routeFunction(String path, Consumer<io.vertx.ext.web.Route> routeFunction)
      Parameters:
      path - A normalized path (e.g. use HttpRootPathBuildItem to construct/resolve the path value) defining the route. This path this is also used on the "Not Found" page in dev mode.
      routeFunction - a Consumer of Route

    • route

      public RouteBuildItem.Builder route(String route)
      Parameters:
      route - A normalized path used to define a basic route (e.g. use HttpRootPathBuildItem to construct/resolve the path value). This path this is also used on the "Not Found" page in dev mode.

    • orderedRoute

      public RouteBuildItem.Builder orderedRoute(String route, Integer order)
      Parameters:
      route - A normalized path used to define a basic route (e.g. use HttpRootPathBuildItem to construct/resolve the path value). This path this is also used on the "Not Found" page in dev mode.
      order - Priority ordering of the route

    • orderedRoute

      public RouteBuildItem.Builder orderedRoute(String route, Integer order, Consumer<io.vertx.ext.web.Route> routeCustomizer)
      Parameters:
      route - A normalized path used to define a basic route (e.g. use HttpRootPathBuildItem to construct/resolve the path value). This path this is also used on the "Not Found" page in dev mode.
      order - Priority ordering of the route
      routeCustomizer - Route customizer.

    • orderedRoute

      public RouteBuildItem.Builder orderedRoute(String name, String route, Integer order, Consumer<io.vertx.ext.web.Route> routeCustomizer)
      Parameters:
      name - The name of the route. It is used to identify the route in the metrics.
      route - A normalized path used to define a basic route (e.g. use HttpRootPathBuildItem to construct/resolve the path value). This path this is also used on the "Not Found" page in dev mode.
      order - Priority ordering of the route
      routeCustomizer - Route customizer.

    • handler

      public RouteBuildItem.Builder handler(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)

    • handlerType

      public RouteBuildItem.Builder handlerType(io.quarkus.vertx.http.runtime.HandlerType handlerType)

    • blockingRoute

      public RouteBuildItem.Builder blockingRoute()

    • failureRoute

      public RouteBuildItem.Builder failureRoute()

    • displayOnNotFoundPage

      public RouteBuildItem.Builder displayOnNotFoundPage()

    • displayOnNotFoundPage

      public RouteBuildItem.Builder displayOnNotFoundPage(String notFoundPageTitle)

    • routeConfigKey

      public RouteBuildItem.Builder routeConfigKey(String attributeName)

    • management

      public RouteBuildItem.Builder management()

    • management

      public RouteBuildItem.Builder management(String managementConfigKey)

    • build

      public RouteBuildItem build()

    • getRouteConfigInfo

      protected ConfiguredPathInfo getRouteConfigInfo()

    • getNotFoundEndpoint

      protected NotFoundPageDisplayableEndpointBuildItem getNotFoundEndpoint()