Package play.mvc

Class Router

java.lang.Object

play.mvc.Router

public class Router
extends java.lang.Object

The router matches HTTP requests to action invocations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Router.ActionDefinition
static class	Router.MatchingRoute
static class	Router.Route

Field Summary

Fields

Modifier and Type	Field	Description
static Router	instance
static long	lastLoading	Timestamp the routes file was last loaded at.

Constructor Summary

Constructors

Constructor	Description
Router(java.util.List<Router.Route> routes)

Method Summary

Modifier and Type	Method	Description
Router.ActionDefinition	actionToUrl(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> actionArgs, Http.Request request, Http.Response response)
static void	addRoute(java.lang.String method, java.lang.String path, java.lang.String action)	Add a new route.
static void	clearForTests()
static void	detectChanges()	In PROD mode and if the routes are already loaded, this does nothing.
static java.lang.String	getBaseUrl()	Deprecated.
static java.lang.String	getBaseUrl(Http.Request request)
static java.lang.String	getFullUrl(java.lang.String action)	Deprecated.
static java.lang.String	getFullUrl(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> args)	Deprecated.
static java.lang.String	getFullUrl(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> args, Http.Request request)
static java.lang.String	getFullUrl(java.lang.String action, Http.Request request)
Router.MatchingRoute	matchRoute(java.lang.String method, java.lang.String path)
static void	resetForTests(java.util.List<Router.Route> routes)
static Router.ActionDefinition	reverse(java.lang.String action)	Deprecated.
static Router.ActionDefinition	reverse(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> args)	Deprecated.
static Router.ActionDefinition	reverse(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> args, Http.Request request, Http.Response response)
static java.lang.String	reverse(VirtualFile file)	Deprecated.
static java.lang.String	reverseWithCheck(java.lang.String name, VirtualFile file, boolean absolute)
void	routeOnlyStatic(Http.Request request)
static java.util.List<Router.Route>	routes()

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static final Router instance

lastLoading

public static long lastLoading

Timestamp the routes file was last loaded at.

Constructor Detail

Router

public Router(java.util.List<Router.Route> routes)

Method Detail

routes

public static java.util.List<Router.Route> routes()

clearForTests

public static void clearForTests()

resetForTests

public static void resetForTests(java.util.List<Router.Route> routes)

addRoute

public static void addRoute(java.lang.String method,
                            java.lang.String path,
                            java.lang.String action)

Add a new route. Will be first in the route list

Parameters:

method - The method of the route * @param action : The associated action

path - The path of the route

action - The associated action

detectChanges

public static void detectChanges()

In PROD mode and if the routes are already loaded, this does nothing.

In DEV mode, this checks each routes file's "last modified" time to see if the routes need updated.

routeOnlyStatic

public void routeOnlyStatic(Http.Request request)

matchRoute

@Nullable
public Router.MatchingRoute matchRoute(java.lang.String method,
                                       java.lang.String path)

reverse

@Deprecated
public static Router.ActionDefinition reverse(java.lang.String action)

Deprecated.

getFullUrl

@Deprecated
public static java.lang.String getFullUrl(java.lang.String action,
                                          java.util.Map<java.lang.String,java.lang.Object> args)

Deprecated.

getFullUrl

public static java.lang.String getFullUrl(java.lang.String action,
                                          java.util.Map<java.lang.String,java.lang.Object> args,
                                          Http.Request request)

getBaseUrl

@Deprecated
public static java.lang.String getBaseUrl()

Deprecated.

Gets baseUrl from current request or application.baseUrl in application.conf

getBaseUrl

public static java.lang.String getBaseUrl(Http.Request request)

getFullUrl

@Deprecated
public static java.lang.String getFullUrl(java.lang.String action)

Deprecated.

getFullUrl

public static java.lang.String getFullUrl(java.lang.String action,
                                          Http.Request request)

reverse

@Deprecated
public static java.lang.String reverse(VirtualFile file)

Deprecated.

reverseWithCheck

public static java.lang.String reverseWithCheck(java.lang.String name,
                                                VirtualFile file,
                                                boolean absolute)

reverse

@Deprecated
public static Router.ActionDefinition reverse(java.lang.String action,
                                              java.util.Map<java.lang.String,java.lang.Object> args)

Deprecated.

reverse

public static Router.ActionDefinition reverse(java.lang.String action,
                                              java.util.Map<java.lang.String,java.lang.Object> args,
                                              Http.Request request,
                                              Http.Response response)

actionToUrl

public Router.ActionDefinition actionToUrl(java.lang.String action,
                                           java.util.Map<java.lang.String,java.lang.Object> actionArgs,
                                           Http.Request request,
                                           Http.Response response)