play

Class GlobalSettings

java.lang.Object

play.GlobalSettings

public class GlobalSettings
extends java.lang.Object

GlobalSettings is instantiated by the framework when an application starts, to let you perform specific tasks at start-up or shut-down.

How to use it: create a Global.java class in your Java application and override the methods you want.

Constructor Summary

Constructors

Constructor and Description
GlobalSettings()

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeStart(Application app) Executed before any plugin - you can set-up your database schema here, for instance.
Result	onBadRequest(Http.RequestHeader request, java.lang.String error) Triggered when a resource was requested but not found, the default implementation returns null, so that the Scala engine handles the onBadRequest.
Result	onError(Http.RequestHeader request, java.lang.Throwable t) Returns a Result that could be a custom error page.
Result	onHandlerNotFound(Http.RequestHeader request) Triggered when a resource was requested but not found.
Action	onRequest(Http.Request request, java.lang.reflect.Method actionMethod) Call to create the root Action of a request for a Java application.
play.api.mvc.Handler	onRouteRequest(Http.RequestHeader request) Called when an HTTP request has been received.
void	onStart(Application app) Executed after all plugins, including the database set-up with Evolutions and the EBean wrapper.
void	onStop(Application app) Executed when the application stops.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalSettings

public GlobalSettings()

Method Detail

beforeStart

public void beforeStart(Application app)

Executed before any plugin - you can set-up your database schema here, for instance.

onStart

public void onStart(Application app)

Executed after all plugins, including the database set-up with Evolutions and the EBean wrapper. This is a good place to execute some of your application code to create entries, for instance.

onStop

public void onStop(Application app)

Executed when the application stops.

onError

public Result onError(Http.RequestHeader request,
             java.lang.Throwable t)

Returns a Result that could be a custom error page. The default implementation returns null, so that the Scala engine handles the excepetion and show an error page.

Parameters:

t - is any throwable

Returns:

null as the default implementation

onRequest

public Action onRequest(Http.Request request,
               java.lang.reflect.Method actionMethod)

Call to create the root Action of a request for a Java application. The request and actionMethod values are passed for information.

Parameters:

request - The HTTP Request

actionMethod - The action method containing the user code for this Action.

Returns:

The default implementation returns a raw Action calling the method.

onRouteRequest

public play.api.mvc.Handler onRouteRequest(Http.RequestHeader request)

Called when an HTTP request has been received. The default implementation (return null) means to use the application router to find the appropriate action By overriding this method one can provide an alternative routing mechanism. Please note, though, this API is very low level, useful for plugin/module authors only.

Parameters:

request - the HTTP request header as seen by the core framework (the body has not been parsed yet)

Returns:

an action to handle this request - if no action is returned, a 404 not found result will be sent to client

onHandlerNotFound

public Result onHandlerNotFound(Http.RequestHeader request)

Triggered when a resource was requested but not found. The default implementation returns null, so that the Scala engine handles the onActionNotFound.

Parameters:

request - the HTTP request

Returns:

null in the default implementation, you can return your own custom Result in your Global class.

onBadRequest

public Result onBadRequest(Http.RequestHeader request,
                  java.lang.String error)

Triggered when a resource was requested but not found, the default implementation returns null, so that the Scala engine handles the onBadRequest.

Parameters:

request - the HTTP request

Returns:

null in the default implementation, you can return your own custom Result in your Global class.