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 Summary

Fields

Modifier and Type	Field	Description
protected String	absolutePath
protected boolean	displayOnNotFoundPage
protected io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>	handler
protected String	notFoundPagePath
protected String	notFoundPageTitle
protected String	routeConfigKey
protected Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route>	routeFunction
protected String	routePath
protected HandlerType	type

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RouteBuildItem.Builder	blockingRoute()
RouteBuildItem	build()
RouteBuildItem.Builder	displayOnNotFoundPage()
RouteBuildItem.Builder	displayOnNotFoundPage(String notFoundPageTitle)
RouteBuildItem.Builder	failureRoute()
protected NotFoundPageDisplayableEndpointBuildItem	getNotFoundEndpoint()
protected ConfiguredPathInfo	getRouteConfigInfo()
RouteBuildItem.Builder	handler(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)
RouteBuildItem.Builder	handlerType(HandlerType handlerType)
RouteBuildItem.Builder	orderedRoute(String route, Integer order)
RouteBuildItem.Builder	orderedRoute(String route, Integer order, Consumer<io.vertx.ext.web.Route> routeCustomizer)
RouteBuildItem.Builder	route(String route)
RouteBuildItem.Builder	routeConfigKey(String attributeName)
RouteBuildItem.Builder	routeFunction(String path, Consumer<io.vertx.ext.web.Route> routeFunction)
RouteBuildItem.Builder	routeFunction(Function<io.vertx.ext.web.Router,io.vertx.ext.web.Route> routeFunction)	Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

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 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

Constructor Detail

Builder

public Builder()

Method Detail

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(String, Consumer)

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.

handler

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

handlerType

public RouteBuildItem.Builder handlerType(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)

build

public RouteBuildItem build()

getRouteConfigInfo

protected ConfiguredPathInfo getRouteConfigInfo()

getNotFoundEndpoint

protected NotFoundPageDisplayableEndpointBuildItem getNotFoundEndpoint()