org.javalite.activeweb

Class Router

java.lang.Object

org.javalite.activeweb.Router

public class Router
extends Object

Responsible for looking at a URI and creating a route to controller if one is found. This is a thread - safe class.

Author:

Igor Polevoy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Router(String rootControllerName)

Method Summary

Modifier and Type	Method and Description
protected static String	findControllerNamePart(String pack, String uri) Now that we know that this controller is under a package, need to find the controller short name.
protected String	findPackageSuffix(String uri) Finds a part of a package name which can be found in between "app.controllers" and short name of class.
static String	generate(String controllerPath, String action, String id, boolean restful, Map params) Generates a URI for a controller.
protected org.javalite.activeweb.ControllerPath	getControllerPath(String uri) Finds a controller path from URI.
protected Route	recognize(String uri, HttpMethod httpMethod) This is a main method for recognizing a route to a controller; used when a request is received.
void	setIgnoreSpecs(List<IgnoreSpec> ignoreSpecs)
void	setRoutes(List<RouteBuilder> routes) Sets custom routes

Methods inherited from class java.lang.Object

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

Constructor Detail

Router

protected Router(String rootControllerName)

Method Detail

setRoutes

public void setRoutes(List<RouteBuilder> routes)

Sets custom routes

Parameters:

routes - se of custom routes defined for app.

recognize

protected Route recognize(String uri,
                          HttpMethod httpMethod)
                   throws ClassLoadException

This is a main method for recognizing a route to a controller; used when a request is received.

Parameters:

uri - URI of incoming request.

httpMethod - http method of the request.

Returns:

instance of a Route if one is found, null if not.

Throws:

ClassLoadException

generate

public static String generate(String controllerPath,
                              String action,
                              String id,
                              boolean restful,
                              Map params)

Generates a URI for a controller.

Parameters:

controllerPath - path to controller.

action - action for a controller

id - id on a URI

restful - true if a route for a restful controller is needed, false for non-restful.

params - name/value pairs to be used to form a query string.

Returns:

formed URI based on arguments.

getControllerPath

protected org.javalite.activeweb.ControllerPath getControllerPath(String uri)

Finds a controller path from URI. Controller path includes a package prefix taken from URI, similar to:

http://host/context/admin/printers/show/1, where "admin" is a "package_suffix", "printers" is a "controller_name".

for example above, the method will Map with two keys: "package_suffix" and "controller_name"

Parameters:

uri - this is a URI - the information after context : "controller/action/whatever".

Returns:

map with two keys: "controller_name" and "package_suffix", both of which can be null.

findControllerNamePart

protected static String findControllerNamePart(String pack,
                                               String uri)

Now that we know that this controller is under a package, need to find the controller short name.

Parameters:

pack - part of the package of the controller, taken from URI: value between "app.controllers" and controller name.

uri - uri from request

Returns:

controller name

findPackageSuffix

protected String findPackageSuffix(String uri)

Finds a part of a package name which can be found in between "app.controllers" and short name of class.

Parameters:

uri - uri from request

Returns:

a part of a package name which can be found in between "app.controllers" and short name of class, or null if not found

setIgnoreSpecs

public void setIgnoreSpecs(List<IgnoreSpec> ignoreSpecs)