play
Class PlayPlugin

java.lang.Object
  play.PlayPlugin

All Implemented Interfaces:

Comparable<PlayPlugin>

Direct Known Subclasses:

CorePlugin, DBPlugin, JobsPlugin, JPAPlugin, MessagesPlugin, TempFilePlugin, ValidationPlugin, WS

public abstract class PlayPlugin
extends Object
implements Comparable<PlayPlugin>

A framework plugin

index

public int index

Plugin priority (0 for highest priority)

PlayPlugin

public PlayPlugin()

onLoad

public void onLoad()

Called at plugin loading

bind

public Object bind(String name,
                   Class clazz,
                   Type type,
                   Map<String,String[]> params)

Called when play need to bind a Java object from HTTP params

getStatus

public String getStatus()

Retun the plugin status

getJsonStatus

public com.google.gson.JsonObject getJsonStatus()

Retun the plugin status in JSON format

enhance

public void enhance(ApplicationClasses.ApplicationClass applicationClass)
             throws Exception

Enhance this class

Parameters:

applicationClass -

Throws:

Exception

rawInvocation

public boolean rawInvocation(Http.Request request,
                             Http.Response response)
                      throws Exception

Let a chance to this plugin to fully manage this request

Parameters:

request - The Play request

response - The Play response

Returns:

true if this plugin has managed this request

Throws:

Exception

serveStatic

public boolean serveStatic(VirtualFile file,
                           Http.Request request,
                           Http.Response response)

Let a chance to this plugin to manage a static ressource

Parameters:

request - The Play request

response - The Play response

Returns:

true if this plugin has managed this request

beforeDetectingChanges

public void beforeDetectingChanges()

detectChange

public void detectChange()

It's time for the plugin to detect changes. Throw an exception is the application must be reloaded.

onApplicationStart

public void onApplicationStart()

Called at application start (and at each reloading) Time to start statefull things.

afterApplicationStart

public void afterApplicationStart()

Called after the application start.

onApplicationStop

public void onApplicationStop()

Called at application stop (and before each reloading) Time to shutdown statefull things.

beforeInvocation

public void beforeInvocation()

Called before a Play! invocation. Time to prepare request specific things.

afterInvocation

public void afterInvocation()

Called after an invocation. (unless an excetion has been thrown). Time to close request specific things.

onInvocationException

public void onInvocationException(Throwable e)

Called if an exception occured during the invocation.

Parameters:

e - The catched exception.

invocationFinally

public void invocationFinally()

Called at the end of the invocation. (even if an exception occured). Time to close request specific things.

beforeActionInvocation

public void beforeActionInvocation(Method actionMethod)

Called before an 'action' invocation, ie an HTTP request processing.

onActionInvocationResult

public void onActionInvocationResult(Result result)

Called when the action method has thrown a result.

Parameters:

result - The result object for the request.

afterActionInvocation

public void afterActionInvocation()

Called at the end of the action invocation.

onConfigurationRead

public void onConfigurationRead()

Called when the application.cond has been read.

onRoutesLoaded

public void onRoutesLoaded()

Called after routes loading.

onEvent

public void onEvent(String message,
                    Object context)

Event may be sent by plugins or other components

Parameters:

message - convention: pluginClassShortName.message

context - depends on the plugin

compileAll

public void compileAll(List<ApplicationClasses.ApplicationClass> classes)

Let a chance to the plugin to compile it owns classes. Must be added to the mutable list.

routeRequest

public void routeRequest(Http.Request request)

Let some plugins route themself

Parameters:

request -

postEvent

public static void postEvent(String message,
                             Object context)

Inter-plugin communication.

compareTo

public int compareTo(PlayPlugin o)

Specified by:

compareTo in interface Comparable<PlayPlugin>