public class RouterHandler extends GenericHeapObject implements Handler
DispatchHandler
.
It looks for route configuration files (very similar to the usual general config file)
in a defined directory (by default it looks in config/routes/).
{
"name": "Router",
"type": "Router",
"config": {
"directory": "/tmp/routes",
"defaultHandler": "404NotFound",
"scanInterval": 2
}
}
Note that scanInterval is defined in seconds. If -1 (or any negative value) is
provided, only an initial scan is performed at startup, synchronously.Modifier and Type | Class and Description |
---|---|
static class |
RouterHandler.Heaplet
Creates and initializes a routing handler in a heap environment.
|
logger, storage
Constructor and Description |
---|
RouterHandler(org.forgerock.openig.handler.router.RouteBuilder builder,
org.forgerock.openig.handler.router.DirectoryScanner scanner)
Builds a router that loads its configuration from the given directory.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
handle(Context context,
Request request)
|
void |
onChanges(org.forgerock.openig.handler.router.FileChangeSet changes)
Notify that changes has been detected in the monitored directory.
|
void |
setDefaultHandler(Handler handler)
Sets the handler which should be invoked when no routes match the
request.
|
void |
setRouteComparator(Comparator<org.forgerock.openig.handler.router.Route> comparator)
Changes the ordering of the managed routes.
|
void |
start()
Starts this handler, executes an initial directory scan.
|
void |
stop()
Stops this handler, shutting down and clearing all the managed routes.
|
getLogger, getStorage, setLogger, setStorage
public RouterHandler(org.forgerock.openig.handler.router.RouteBuilder builder, org.forgerock.openig.handler.router.DirectoryScanner scanner)
builder
- route builderscanner
- DirectoryScanner
that will be invoked at each incoming requestpublic void setRouteComparator(Comparator<org.forgerock.openig.handler.router.Route> comparator)
comparator
- route comparatorpublic void setDefaultHandler(Handler handler)
handler
- the handler which should be invoked when no routes match the
requestpublic void start()
public void stop()
public void onChanges(org.forgerock.openig.handler.router.FileChangeSet changes)
changes
- Content of the change setpublic Promise<Response,NeverThrowsException> handle(Context context, Request request)
Handler
Promise
representing the asynchronous Response
of the given request
.
If any (asynchronous) processing goes wrong, the promise still contains a Response
(probably from the
4xx or 5xx status code family).
A handler that doesn't hand-off the processing to another downstream handler is responsible for creating the response.
The returned Promise
contains the response returned from the server as-is.
This is responsibility of the handler to produce the appropriate error response (404,
500, ...) in case of processing error.
Note: As of Promise 2.0 implementation, it is not permitted to throw any runtime exception here. Doing so produce unexpected behaviour (most likely a server-side hang of the processing thread).
Copyright 2011-2015 ForgeRock AS.