Package io.quarkus.vertx.http.deployment

Class RouteBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.vertx.http.deployment.RouteBuildItem

public final class RouteBuildItem
extends io.quarkus.builder.item.MultiBuildItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RouteBuildItem.Builder	HttpRootPathBuildItem.Builder and NonApplicationRootPathBuildItem.Builder extend this.
static enum	RouteBuildItem.RouteType

Constructor Summary

Constructors

Constructor	Description
RouteBuildItem(RouteBuildItem.Builder builder, RouteBuildItem.RouteType routeType, RouteBuildItem.RouteType routerType, boolean management)

Method Summary

Modifier and Type	Method	Description
static RouteBuildItem.Builder	builder()
ConfiguredPathInfo	getConfiguredPathInfo()
io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>	getHandler()
NotFoundPageDisplayableEndpointBuildItem	getNotFoundPageDisplayableEndpoint()
Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route>	getRouteFunction()
RouteBuildItem.RouteType	getRouterType()
RouteBuildItem.RouteType	getRouteType()
HandlerType	getType()
boolean	isManagement()
boolean	isRouterAbsolute()
boolean	isRouterApplication()
boolean	isRouterFramework()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RouteBuildItem

RouteBuildItem(RouteBuildItem.Builder builder,
 RouteBuildItem.RouteType routeType,
 RouteBuildItem.RouteType routerType,
 boolean management)

Method Details

builder

public static RouteBuildItem.Builder builder()

getHandler

public io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> getHandler()

getType

public HandlerType getType()

getRouteFunction

public Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route> getRouteFunction()

getRouteType

public RouteBuildItem.RouteType getRouteType()

getRouterType

public RouteBuildItem.RouteType getRouterType()

isRouterFramework

public boolean isRouterFramework()

isRouterApplication

public boolean isRouterApplication()

isRouterAbsolute

public boolean isRouterAbsolute()

getNotFoundPageDisplayableEndpoint

public NotFoundPageDisplayableEndpointBuildItem getNotFoundPageDisplayableEndpoint()

getConfiguredPathInfo

public ConfiguredPathInfo getConfiguredPathInfo()

isManagement

public boolean isManagement()

Returns:

true if the route is exposing a management endpoint. It matters when using a different interface/port for the management endpoints, as these routes will only be accessible from that different interface/port.