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, notFoundPagePath, notFoundPageTitle, routeConfigKey, routeFunction, routePath, type

Constructor Summary

Constructors

Constructor and Description
Builder(NonApplicationRootPathBuildItem buildItem)

Method Summary

Modifier and Type	Method and Description
NonApplicationRootPathBuildItem.Builder	blockingRoute()
RouteBuildItem	build()
NonApplicationRootPathBuildItem.Builder	displayOnNotFoundPage()
NonApplicationRootPathBuildItem.Builder	displayOnNotFoundPage(String notFoundPageTitle)
NonApplicationRootPathBuildItem.Builder	displayOnNotFoundPage(String notFoundPageTitle, String notFoundPagePath)
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	nestedRoute(String baseRoute, String subRoute)
NonApplicationRootPathBuildItem.Builder	requiresLegacyRedirect() Deprecated. This will be removed in Quarkus 2.0, don't use unless you have to.
NonApplicationRootPathBuildItem.Builder	route(String route)
NonApplicationRootPathBuildItem.Builder	routeConfigKey(String attributeName)
NonApplicationRootPathBuildItem.Builder	routeFunction(Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route> routeFunction) RouteBuildItem.Builder.routeFunction(String, Consumer) should be used instead
NonApplicationRootPathBuildItem.Builder	routeFunction(String route, Consumer<io.vertx.ext.web.Route> routeFunction)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

Builder(NonApplicationRootPathBuildItem buildItem)

Method Detail

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.

nestedRoute

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

requiresLegacyRedirect

@Deprecated
public NonApplicationRootPathBuildItem.Builder requiresLegacyRedirect()

Deprecated. This will be removed in Quarkus 2.0, don't use unless you have to.

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

displayOnNotFoundPage

public NonApplicationRootPathBuildItem.Builder displayOnNotFoundPage(String notFoundPageTitle,
                                                                     String notFoundPagePath)

Overrides:

displayOnNotFoundPage in class RouteBuildItem.Builder

See Also:

RouteBuildItem.Builder.route(String), RouteBuildItem.Builder.routeFunction(String, Consumer)

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