io.vertx.ext.routematcher.impl

Class RouteMatcherImpl

java.lang.Object

io.vertx.ext.routematcher.impl.RouteMatcherImpl

All Implemented Interfaces:

RouteMatcher

public class RouteMatcherImpl
extends Object
implements RouteMatcher

This class allows you to do route requests based on the HTTP verb and the request URI, in a manner similar to Sinatra or Express.

RouteMatcher also lets you extract parameters from the request URI either a simple pattern or using regular expressions for more complex matches. Any parameters extracted will be added to the requests parameters which will be available to you in your request handler.

It's particularly useful when writing REST-ful web applications.

To use a simple pattern to extract parameters simply prefix the parameter name in the pattern with a ':' (colon).

Different handlers can be specified for each of the HTTP verbs, GET, POST, PUT, DELETE etc.

For more complex matches regular expressions can be used in the pattern. When regular expressions are used, the extracted parameters do not have a name, so they are put into the HTTP request with names of param0, param1, param2 etc.

Multiple matches can be specified for each HTTP verb. In the case there are more than one matching patterns for a particular request, the first matching one will be used.

Instances of this class are not thread-safe

Author:

Tim Fox

Constructor Summary

Constructors

Constructor and Description
RouteMatcherImpl() Do not instantiate this directly - use RouteMatcher.newRouteMatcher() instead

Method Summary

Modifier and Type	Method and Description
RouteMatcher	accept(io.vertx.core.http.HttpServerRequest request)
RouteMatcherImpl	all(String pattern, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler) Specify a handler that will be called for all HTTP methods
RouteMatcherImpl	allWithRegEx(String regex, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler) Specify a handler that will be called for all HTTP methods
RouteMatcher	matchMethod(io.vertx.core.http.HttpMethod method, String pattern, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler) Specify a handler that will be called for a matching request
RouteMatcher	matchMethodWithRegEx(io.vertx.core.http.HttpMethod method, String regex, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler) Specify a handler that will be called for a matching request
RouteMatcherImpl	noMatch(io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler) Specify a handler that will be called when no other handlers match.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.routematcher.RouteMatcher

routeMatcher

Constructor Detail

RouteMatcherImpl

public RouteMatcherImpl()

Do not instantiate this directly - use RouteMatcher.newRouteMatcher() instead

Method Detail

accept

public RouteMatcher accept(io.vertx.core.http.HttpServerRequest request)

Specified by:

accept in interface RouteMatcher

matchMethod

public RouteMatcher matchMethod(io.vertx.core.http.HttpMethod method,
                                String pattern,
                                io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler)

Description copied from interface: RouteMatcher

Specify a handler that will be called for a matching request

Specified by:

matchMethod in interface RouteMatcher

Parameters:

method - - the HTTP method

pattern - The simple pattern

handler - The handler to call

matchMethodWithRegEx

public RouteMatcher matchMethodWithRegEx(io.vertx.core.http.HttpMethod method,
                                         String regex,
                                         io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler)

Description copied from interface: RouteMatcher

Specify a handler that will be called for a matching request

Specified by:

matchMethodWithRegEx in interface RouteMatcher

Parameters:

method - - the HTTP method

regex - The simple pattern

handler - The handler to call

all

public RouteMatcherImpl all(String pattern,
                            io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler)

Specify a handler that will be called for all HTTP methods

Specified by:

all in interface RouteMatcher

Parameters:

pattern - The simple pattern

handler - The handler to call

allWithRegEx

public RouteMatcherImpl allWithRegEx(String regex,
                                     io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler)

Specify a handler that will be called for all HTTP methods

Specified by:

allWithRegEx in interface RouteMatcher

Parameters:

regex - A regular expression

handler - The handler to call

noMatch

public RouteMatcherImpl noMatch(io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> handler)

Specify a handler that will be called when no other handlers match. If this handler is not specified default behaviour is to return a 404

Specified by:

noMatch in interface RouteMatcher