Package io.quarkus.vertx.http.deployment

Class NonApplicationRootPathBuildItem.Builder

java.lang.Object

io.quarkus.vertx.http.deployment.RouteBuildItem.Builder

io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem.Builder

Enclosing class:

NonApplicationRootPathBuildItem

public static class NonApplicationRootPathBuildItem.Builder
extends RouteBuildItem.Builder

Per non-application endpoint instance.

Field Summary

Fields inherited from class io.quarkus.vertx.http.deployment.RouteBuildItem.Builder

absolutePath, displayOnNotFoundPage, handler, isManagement, notFoundPagePath, notFoundPageTitle, routeConfigKey, routeFunction, routePath, type

Constructor Summary

Constructors

Constructor	Description
Builder(NonApplicationRootPathBuildItem buildItem)

Method Summary

Modifier and Type	Method	Description
NonApplicationRootPathBuildItem.Builder	blockingRoute()
RouteBuildItem	build()
NonApplicationRootPathBuildItem.Builder	displayOnNotFoundPage()
NonApplicationRootPathBuildItem.Builder	displayOnNotFoundPage(String notFoundPageTitle)
NonApplicationRootPathBuildItem.Builder	failureRoute()
protected NotFoundPageDisplayableEndpointBuildItem	getNotFoundEndpoint()
protected ConfiguredPathInfo	getRouteConfigInfo()
NonApplicationRootPathBuildItem.Builder	handler(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)
NonApplicationRootPathBuildItem.Builder	handlerType(HandlerType handlerType)
NonApplicationRootPathBuildItem.Builder	management()
NonApplicationRootPathBuildItem.Builder	management(String managementConfigKey)
NonApplicationRootPathBuildItem.Builder	nestedRoute(String baseRoute, String subRoute)
NonApplicationRootPathBuildItem.Builder	orderedRoute(String route, Integer order)
NonApplicationRootPathBuildItem.Builder	orderedRoute(String route, Integer order, Consumer<io.vertx.ext.web.Route> routeFunction)
NonApplicationRootPathBuildItem.Builder	route(String route)
NonApplicationRootPathBuildItem.Builder	routeConfigKey(String attributeName)
NonApplicationRootPathBuildItem.Builder	routeFunction(String route, Consumer<io.vertx.ext.web.Route> routeFunction)
NonApplicationRootPathBuildItem.Builder	routeFunction(Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route> routeFunction)	RouteBuildItem.Builder.routeFunction(String, Consumer) should be used instead

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

Builder(NonApplicationRootPathBuildItem buildItem)

Method Details

routeFunction

public NonApplicationRootPathBuildItem.Builder routeFunction(Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route> routeFunction)

Description copied from class: RouteBuildItem.Builder

RouteBuildItem.Builder.routeFunction(String, Consumer) should be used instead

Overrides:

routeFunction in class RouteBuildItem.Builder

See Also:

• RouteBuildItem.Builder.routeFunction(String, Consumer)

routeFunction

public NonApplicationRootPathBuildItem.Builder routeFunction(String route,
 Consumer<io.vertx.ext.web.Route> routeFunction)

Overrides:

routeFunction in class RouteBuildItem.Builder

Parameters:

route - 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 NonApplicationRootPathBuildItem.Builder route(String route)

Overrides:

route in class RouteBuildItem.Builder

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 NonApplicationRootPathBuildItem.Builder orderedRoute(String route,
 Integer order)

Overrides:

orderedRoute in class RouteBuildItem.Builder

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 NonApplicationRootPathBuildItem.Builder orderedRoute(String route,
 Integer order,
 Consumer<io.vertx.ext.web.Route> routeFunction)

Overrides:

orderedRoute in class RouteBuildItem.Builder

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

routeFunction - Route customizer.

nestedRoute

public NonApplicationRootPathBuildItem.Builder nestedRoute(String baseRoute,
 String subRoute)

handler

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

Overrides:

handler in class RouteBuildItem.Builder

handlerType

public NonApplicationRootPathBuildItem.Builder handlerType(HandlerType handlerType)

Overrides:

handlerType in class RouteBuildItem.Builder

blockingRoute

public NonApplicationRootPathBuildItem.Builder blockingRoute()

Overrides:

blockingRoute in class RouteBuildItem.Builder

failureRoute

public NonApplicationRootPathBuildItem.Builder failureRoute()

Overrides:

failureRoute in class RouteBuildItem.Builder

displayOnNotFoundPage

public NonApplicationRootPathBuildItem.Builder displayOnNotFoundPage()

Overrides:

displayOnNotFoundPage in class RouteBuildItem.Builder

displayOnNotFoundPage

public NonApplicationRootPathBuildItem.Builder displayOnNotFoundPage(String notFoundPageTitle)

Overrides:

displayOnNotFoundPage in class RouteBuildItem.Builder

routeConfigKey

public NonApplicationRootPathBuildItem.Builder routeConfigKey(String attributeName)

Overrides:

routeConfigKey in class RouteBuildItem.Builder

build

public RouteBuildItem build()

Overrides:

build in class RouteBuildItem.Builder

getRouteConfigInfo

protected ConfiguredPathInfo getRouteConfigInfo()

Overrides:

getRouteConfigInfo in class RouteBuildItem.Builder

getNotFoundEndpoint

protected NotFoundPageDisplayableEndpointBuildItem getNotFoundEndpoint()

Overrides:

getNotFoundEndpoint in class RouteBuildItem.Builder

management

public NonApplicationRootPathBuildItem.Builder management()

Overrides:

management in class RouteBuildItem.Builder

management

public NonApplicationRootPathBuildItem.Builder management(String managementConfigKey)

Overrides:

management in class RouteBuildItem.Builder