ninja

Class RouterImpl

java.lang.Object

ninja.RouterImpl

All Implemented Interfaces:

Router

public class RouterImpl
extends java.lang.Object
implements Router

Constructor Summary

Constructors

Constructor and Description
RouterImpl(com.google.inject.Injector injector, NinjaProperties ninjaProperties)

Method Summary

Modifier and Type	Method and Description
void	compileRoutes() Compile all the routes that have been registered with the router.
RouteBuilder	DELETE()
RouteBuilder	GET()
java.lang.String	getReverseRoute(java.lang.Class<?> controllerClass, java.lang.String controllerMethodName) Retrieves the reverse route for this controllerClass and method.
java.lang.String	getReverseRoute(java.lang.Class<?> controllerClass, java.lang.String controllerMethodName, java.util.Map<java.lang.String,java.lang.Object> parameterMap) Retrieves the reverse route for this controllerClass and method.
java.lang.String	getReverseRoute(java.lang.Class<?> controllerClass, java.lang.String controllerMethodName, java.lang.Object... parameterMap) Retrieves the reverse route for this controllerClass and method.
java.lang.String	getReverseRoute(java.lang.Class<?> controllerClass, java.lang.String controllerMethodName, com.google.common.base.Optional<java.util.Map<java.lang.String,java.lang.Object>> parameterMap) Retrieves the reverse route for this controllerClass and method.
Route	getRouteFor(java.lang.String httpMethod, java.lang.String uri) Get the route for the given method and URI
java.util.List<Route>	getRoutes() Returns the list of compiled routes.
RouteBuilder	HEAD()
RouteBuilder	METHOD(java.lang.String method) To match any http method.
RouteBuilder	OPTIONS()
RouteBuilder	POST()
RouteBuilder	PUT()

Methods inherited from class java.lang.Object

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

Constructor Detail

RouterImpl

@Inject
public RouterImpl(com.google.inject.Injector injector,
                          NinjaProperties ninjaProperties)

Method Detail

getRouteFor

public Route getRouteFor(java.lang.String httpMethod,
                         java.lang.String uri)

Description copied from interface: Router

Get the route for the given method and URI

Specified by:

getRouteFor in interface Router

Parameters:

httpMethod - The method

uri - The URI

Returns:

The route

getReverseRoute

public java.lang.String getReverseRoute(java.lang.Class<?> controllerClass,
                                        java.lang.String controllerMethodName)

Description copied from interface: Router

Retrieves the reverse route for this controllerClass and method. Does not work with routes that contain placeholders. Use Router.getReverseRoute(Class, String, Map) in that case

Specified by:

getReverseRoute in interface Router

Parameters:

controllerClass - The controllerClass e.g. ApplicationController.class

controllerMethodName - the methodName of the class e.g. "index"

Returns:

The final url (without server, and without any prefixes)

getReverseRoute

public java.lang.String getReverseRoute(java.lang.Class<?> controllerClass,
                                        java.lang.String controllerMethodName,
                                        java.lang.Object... parameterMap)

Description copied from interface: Router

Retrieves the reverse route for this controllerClass and method. The map contains pairs of url parameters. Eg. a raw route like "/person/{id} will become /person/1 when the map contains a pair like "id, "1".

Specified by:

getReverseRoute in interface Router

Parameters:

controllerClass - The controllerClass e.g. ApplicationController.class

controllerMethodName - the methodName of the class e.g. "index"

parameterMap - The map containing pairs with replacements for placeholders. Always supply key and value pairs. Key as strings, Values as objects. To get the value "toString()" is called on the object. Make sure that works for your object or simply use a String. If the raw uri does not contain the placeholders they will be added as query parameters ?key=value&key2=value2 and so on

Returns:

The final url (without server, and without any prefixes)

getReverseRoute

public java.lang.String getReverseRoute(java.lang.Class<?> controllerClass,
                                        java.lang.String controllerMethodName,
                                        com.google.common.base.Optional<java.util.Map<java.lang.String,java.lang.Object>> parameterMap)

Description copied from interface: Router

Retrieves the reverse route for this controllerClass and method. The map contains pairs of url parameters. Eg. a raw route like "/person/{id} will become /person/1 when the map contains a pair like "id, "1".

Specified by:

getReverseRoute in interface Router

parameterMap - An optinal map containing pairs with replacements for placeholders. Always supply key and value pairs. Key as strings, Values as objects. To get the value "toString()" is called on the object. Make sure that works for your object or simply use a String. If the raw uri does not contain the placeholders they will be added as query parameters ?key=value&key2=value2 and so on

Returns:

The final url (without server, and without any prefixes)

getReverseRoute

public java.lang.String getReverseRoute(java.lang.Class<?> controllerClass,
                                        java.lang.String controllerMethodName,
                                        java.util.Map<java.lang.String,java.lang.Object> parameterMap)

Description copied from interface: Router

Retrieves the reverse route for this controllerClass and method. The map contains pairs of url parameters. Eg. a raw route like "/person/{id} will become /person/1 when the map contains a pair like "id, "1".

Specified by:

getReverseRoute in interface Router

Parameters:

controllerClass - The controllerClass e.g. ApplicationController.class

controllerMethodName - the methodName of the class e.g. "index"

Returns:

The final url (without server, and without any prefixes)

compileRoutes

public void compileRoutes()

Description copied from interface: Router

Compile all the routes that have been registered with the router. This should be called once, during initialization, before the application starts serving requests.

Specified by:

compileRoutes in interface Router

getRoutes

public java.util.List<Route> getRoutes()

Description copied from interface: Router

Returns the list of compiled routes.

Specified by:

getRoutes in interface Router

GET

public RouteBuilder GET()

Specified by:

GET in interface Router

POST

public RouteBuilder POST()

Specified by:

POST in interface Router

PUT

public RouteBuilder PUT()

Specified by:

PUT in interface Router

DELETE

public RouteBuilder DELETE()

Specified by:

DELETE in interface Router

OPTIONS

public RouteBuilder OPTIONS()

Specified by:

OPTIONS in interface Router

HEAD

public RouteBuilder HEAD()

Specified by:

HEAD in interface Router

METHOD

public RouteBuilder METHOD(java.lang.String method)

Description copied from interface: Router

To match any http method. E.g. METHOD("PROPFIND") would route PROPFIND methods.

Specified by:

METHOD in interface Router

Parameters:

method - The http method like "GET" or "PROPFIND"

Returns:

the routeBuilder for chaining.