public class RouteMatcher extends java.lang.Object implements Handler<HttpServerRequest>
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
Constructor and Description |
---|
RouteMatcher() |
Modifier and Type | Method and Description |
---|---|
RouteMatcher |
all(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for all HTTP methods
|
RouteMatcher |
allWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for all HTTP methods
|
RouteMatcher |
connect(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP CONNECT
|
RouteMatcher |
connectWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP CONNECT
|
RouteMatcher |
delete(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP DELETE
|
RouteMatcher |
deleteWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP DELETE
|
RouteMatcher |
get(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP GET
|
RouteMatcher |
getWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP GET
|
void |
handle(HttpServerRequest request)
Something has happened, so handle it.
|
RouteMatcher |
head(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP HEAD
|
RouteMatcher |
headWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP HEAD
|
RouteMatcher |
noMatch(Handler<HttpServerRequest> handler)
Specify a handler that will be called when no other handlers match.
|
RouteMatcher |
options(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP OPTIONS
|
RouteMatcher |
optionsWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP OPTIONS
|
RouteMatcher |
patch(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP PATCH
|
RouteMatcher |
patchWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP PATCH
|
RouteMatcher |
post(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP POST
|
RouteMatcher |
postWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP POST
|
RouteMatcher |
put(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP PUT
|
RouteMatcher |
putWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP PUT
|
RouteMatcher |
trace(java.lang.String pattern,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP TRACE
|
RouteMatcher |
traceWithRegEx(java.lang.String regex,
Handler<HttpServerRequest> handler)
Specify a handler that will be called for a matching HTTP TRACE
|
public void handle(HttpServerRequest request)
Handler
handle
in interface Handler<HttpServerRequest>
public RouteMatcher get(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher put(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher post(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher delete(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher options(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher head(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher trace(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher connect(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher patch(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher all(java.lang.String pattern, Handler<HttpServerRequest> handler)
pattern
- The simple patternhandler
- The handler to callpublic RouteMatcher getWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher putWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher postWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher deleteWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher optionsWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher headWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher traceWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher connectWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher patchWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher allWithRegEx(java.lang.String regex, Handler<HttpServerRequest> handler)
regex
- A regular expressionhandler
- The handler to callpublic RouteMatcher noMatch(Handler<HttpServerRequest> handler)