Method Detail

• abstract void before(java.lang.String path, Handler handler)

  Creates an interceptor for a specific path.

  Parameters:

  path - The path to intercept. E.g. /private/*

  handler - A handler.

• abstract void before(Handler handler)

  Creates an interceptor that intercepts all routes following this one.

  Parameters:

  handler - A handler.

• abstract void beforeRegex(java.lang.String path, Handler handler)

  Creates an interceptor using regex as a path pattern.

  Parameters:

  path - The path pattern. E.g. ^/private-.*

  handler - A handler.

• abstract Route delete(java.lang.String path)

  Create a DELETE route.

  Parameters:

  path - The route path.

  Returns:

  a DELETE route.

• abstract Route delete(java.lang.String path, Handler handler)

  Create a DELETE route and set a handler.

  Parameters:

  path - The route path.

  handler - A handler.

  Returns:

  A DELETE route.

• abstract Route get(java.lang.String path)

  Create a GET route.

  Parameters:

  path - The route path.

  Returns:

  a GET route.

• abstract Route get(java.lang.String path, Handler handler)

  Create a GET route and set a handler.

  Parameters:

  path - The route path.

  handler - A handler.

  Returns:

  A GET route.

• abstract Route patch(java.lang.String path)

  Create a PATCH route.

  Parameters:

  path - The route path.

  Returns:

  a PATCH route.

• abstract Route patch(java.lang.String path, Handler handler)

  Create a PATCH route and set a handler.

  Parameters:

  path - The route path.

  handler - A handler.

  Returns:

  A PATCH route.

• abstract void path(java.lang.String path, StaticHandlerOptions handlerOptions)

  Serve a directory using a static files handler.

  Parameters:

  path - A path.

  handlerOptions - Configuration for the static files handler.

  Returns:

  A GET route.

• abstract void path(java.lang.String prefix, java.lang.Class<? extends java.util.function.Consumer<Router>> consumerClass)

  Mount a sub-router at a particular path.

  Parameters:

  prefix - A path prefix such as /api/*

  consumerClass - A Class that implements java.util.function.Consumer

• abstract void path(java.lang.String path, io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)

  Mount a Vert.x Web handler to the routing stack at a specified path.

  Parameters:

  path - The path/path prefix

  handler - A Vert.x Web handler like CORSHandler

• abstract void pathRegex(java.lang.String regex, StaticHandlerOptions handlerOptions)

  Use a RegEx pattern to specify a path at which to mount the static files handler. Uses a String as the pattern to match the Vert.x router method signature.

  Parameters:

  regex - A RegEx pattern.

  handler - A handler.

  Returns:

  A GET route.

• abstract Route post(java.lang.String path)

  Create a POST route.

  Parameters:

  path - The route path.

  Returns:

  a POST route.

• abstract Route post(java.lang.String path, Handler handler)

  Create a POST route and set a handler.

  Parameters:

  path - The route path.

  handler - A handler.

  Returns:

  A POST route.

• abstract Route put(java.lang.String path)

  Create a PUT route.

  Parameters:

  path - The route path.

  Returns:

  a PUT route.

• abstract Route put(java.lang.String path, Handler handler)

  Create a PUT route and set a handler.

  Parameters:

  path - The route path.

  handler - A handler.

  Returns:

  A PUT route.

• abstract void use(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)

  Mount a Vert.x Web handler to the routing stack.

  Parameters:

  handler - A Vert.x Web handler like CORSHandler