sirius.web.controller

Class Route

java.lang.Object

sirius.web.controller.Route

public class Route
extends Object

Represents a compiled routed as a result of parsing a Controller and its methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<Object>	NO_MATCH

Constructor Summary

Constructors

Constructor and Description
Route()

Method Summary

Modifier and Type	Method and Description
protected String	checkAuth(UserInfo user) Determines if the current user is authorized to access this routing.
protected static Route	compile(Controller controller, Method method, Routed routed) Compiles a method defined by a Controller
Controller	getController() Returns the controller owning this route.
protected Method	getMethod() Returns the method which is to be invoked if the an URI can be successfully routed using this route (all parameters match).
protected String	getPattern() Returns a string representation of the internal matching pattern, to detect routes which match the same URLs.
protected boolean	isJSONCall() Determines if the route will result in a JSON response.
protected boolean	isPreDispatchable() Determines if the route is pre dispatchable.
protected List<Object>	matches(WebContext ctx, String requestedURI, boolean preDispatch) Determines if this route matches the current request.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_MATCH

protected static final List<Object> NO_MATCH

Constructor Detail

Route

public Route()

Method Detail

compile

protected static Route compile(Controller controller,
                               Method method,
                               Routed routed)

Compiles a method defined by a Controller

Parameters:

controller - the controller owning the route

method - the method wearing the Routed annotation

routed - the Routed annotation

Returns:

a compiled matcher handling matching URIs

matches

protected List<Object> matches(WebContext ctx,
                               String requestedURI,
                               boolean preDispatch)

Determines if this route matches the current request.

Parameters:

ctx - defines the current request

requestedURI - contains the request uri as string

preDispatch - determines if we're doing a pre-dispatch (looking for a controller which handles incomplete requests like file uploads)

Returns:

NO_MATCH if the route does not match or a list of extracted object from the URI as defined by the template

checkAuth

protected String checkAuth(UserInfo user)

Determines if the current user is authorized to access this routing.

Parameters:

user - the current user

Returns:

null if the user is authorized or otherwise the name of the permission which the user is missing.

toString

public String toString()

Overrides:

toString in class Object

getMethod

protected Method getMethod()

Returns the method which is to be invoked if the an URI can be successfully routed using this route (all parameters match).

Returns:

the method to be invoke in order to route a request using this route

getController

public Controller getController()

Returns the controller owning this route.

Returns:

the controller owning this route

isPreDispatchable

protected boolean isPreDispatchable()

Determines if the route is pre dispatchable. In order to process requests, the last parameter of the method must be of type InputStreamHandler which will be used to process the payload of the request.

Returns:

true if the request is pre dispatchable, false otherwise

isJSONCall

protected boolean isJSONCall()

Determines if the route will result in a JSON response.

Returns:

the value of isJSONCall() of the annotation which created this route

getPattern

protected String getPattern()

Returns a string representation of the internal matching pattern, to detect routes which match the same URLs.

Returns:

a string representation of the internal matching pattern