Package play.mvc

Class Router

java.lang.Object

play.mvc.Router

public class Router
extends 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 final Router	instance
static long	lastLoading	Timestamp the routes file was last loaded at.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Router.ActionDefinition	actionToUrl(String action, Map<String,Object> actionArgs, String requestFormat, Charset encoding)
Router.ActionDefinition	actionToUrl(String action, Map<String,Object> actionArgs, Http.Request request, Http.Response response)
static void	addRoute(String method, String path, 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 String	getBaseUrl()	Deprecated.
static String	getBaseUrl(Http.Request request)
static String	getConfiguredBaseUrl()
static String	getFullUrl(String action)	Deprecated.
static String	getFullUrl(String action, String baseUrl)
static String	getFullUrl(String action, Map<String,Object> args)	Deprecated.
static String	getFullUrl(String action, Map<String,Object> args, String baseUrl)
static String	getFullUrl(String action, Map<String,Object> args, Http.Request request)
static String	getFullUrl(String action, Http.Request request)
Router.MatchingRoute	matchRoute(String method, String path)
static String	reverse(File file)	Deprecated.
static Router.ActionDefinition	reverse(String action)	Deprecated.
static Router.ActionDefinition	reverse(String action, Map<String,Object> args)	Deprecated.
static Router.ActionDefinition	reverse(String action, Map<String,Object> args, String requestFormat, Charset encoding)
static Router.ActionDefinition	reverse(String action, Map<String,Object> args, Http.Request request, Http.Response response)
static String	reverseWithCheck(String name, File file, boolean absolute)
void	routeOnlyStatic(Http.Request request)
static List<Router.Route>	routes()
void	setRoutes(List<Router.Route> routes)	Replace routes with provided route definitions.

Methods inherited from class java.lang.Object

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

Field Details

instance

public static final Router instance

lastLoading

public static long lastLoading

Timestamp the routes file was last loaded at.

Constructor Details

Router

public Router(List<Router.Route> routes)

Method Details

routes

public static List<Router.Route> routes()

setRoutes

public void setRoutes(List<Router.Route> routes)

Replace routes with provided route definitions.

clearForTests

public static void clearForTests()

addRoute

public static void addRoute(String method,
 String path,
 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)

Throws:

RenderStatic - or NotFound

matchRoute

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

reverse

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

Deprecated.

getFullUrl

@Deprecated
@Nonnull
public static String getFullUrl(String action,
 Map<String,Object> args)

Deprecated.

getFullUrl

@Nonnull
public static String getFullUrl(String action,
 Map<String,Object> args,
 @Nullable
 Http.Request request)

getFullUrl

@Nonnull
public static String getFullUrl(@Nonnull
 String action,
 @Nonnull
 Map<String,Object> args,
 @Nonnull
 String baseUrl)

getBaseUrl

@Deprecated
@Nonnull
public static String getBaseUrl()

Deprecated.

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

getBaseUrl

@Nonnull
public static String getBaseUrl(@Nullable
 Http.Request request)

getConfiguredBaseUrl

@Nonnull
public static String getConfiguredBaseUrl()

getFullUrl

@Deprecated
@Nonnull
public static String getFullUrl(@Nonnull
 String action)

Deprecated.

getFullUrl

@Nonnull
public static String getFullUrl(@Nonnull
 String action,
 @Nullable
 Http.Request request)

getFullUrl

@Nonnull
public static String getFullUrl(@Nonnull
 String action,
 @Nonnull
 String baseUrl)

reverse

@Deprecated
public static String reverse(File file)

Deprecated.

reverseWithCheck

public static String reverseWithCheck(String name,
 File file,
 boolean absolute)

reverse

@Deprecated
@Nonnull
public static Router.ActionDefinition reverse(@Nonnull
 String action,
 @Nullable
 Map<String,Object> args)

Deprecated.

reverse

@Nonnull
public static Router.ActionDefinition reverse(@Nonnull
 String action,
 @Nullable
 Map<String,Object> args,
 @Nullable
 Http.Request request,
 @Nullable
 Http.Response response)

reverse

@Nonnull
public static Router.ActionDefinition reverse(@Nonnull
 String action,
 @Nullable
 Map<String,Object> args,
 @Nonnull
 String requestFormat,
 @Nullable
 Charset encoding)

actionToUrl

@Nonnull
public Router.ActionDefinition actionToUrl(@Nonnull
 String action,
 @Nullable
 Map<String,Object> actionArgs,
 @Nullable
 Http.Request request,
 @Nullable
 Http.Response response)

actionToUrl

@Nonnull
public Router.ActionDefinition actionToUrl(@Nonnull
 String action,
 @Nullable
 Map<String,Object> actionArgs,
 @Nonnull
 String requestFormat,
 @Nullable
 Charset encoding)