PlayPlugin (Play! API)

java.lang.Object
- play.PlayPlugin

All Implemented Interfaces:

Comparable<PlayPlugin>

Direct Known Subclasses:

ConfigurablePluginDisablingPlugin, ConfigurationChangeWatcherPlugin, CorePlugin, DBPlugin, Evolutions, JobsPlugin, JPAPlugin, MessagesPlugin, TempFilePlugin, ValidationPlugin, WS
```
public abstract class PlayPlugin
extends Object
implements Comparable<PlayPlugin>
```
A framework plugin

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PlayPlugin.Filter<T>
Class that define a filter.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PlayPlugin.Filter<T>` Class that define a filter.

Field Summary

Fields
Modifier and Type Field and Description

int index
Plugin priority (0 for highest priority)

Fields
Modifier and Type	Field and Description
`int`	`index` Plugin priority (0 for highest priority)

Constructor Summary

Constructors
Constructor and Description

PlayPlugin()

Constructors
Constructor and Description
`PlayPlugin()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Map<String,String>`	`addMimeTypes()` Override to provide additional mime types from your plugin.
`List<String>`	`addTemplateExtensions()`
`void`	`afterActionInvocation()` Called at the end of the action invocation.
`void`	`afterApplicationStart()` Called after the application start.
`void`	`afterFixtureLoad()`
`void`	`afterInvocation()` Called after an invocation.
`void`	`beforeActionInvocation(Method actionMethod)` Called before an 'action' invocation, ie an HTTP request processing.
`void`	`beforeDetectingChanges()`
`void`	`beforeInvocation()` Called before a Play!
`Object`	`bind(RootParamNode rootParamNode, String name, Class<?> clazz, Type type, Annotation[] annotations)` Called when play need to bind a Java object from HTTP params.
`Object`	`bind(String name, Class clazz, Type type, Annotation[] annotations, Map<String,String[]> params)` Deprecated.
`Object`	`bind(String name, Object o, Map<String,String[]> params)` Deprecated.
`Object`	`bindBean(RootParamNode rootParamNode, String name, Object bean)` Called when play need to bind an existing Java object from HTTP params.
`int`	`compareTo(PlayPlugin o)`
`void`	`compileAll(List<ApplicationClasses.ApplicationClass> classes)` Deprecated.
`boolean`	`compileSources()`
`void`	`detectChange()` It's time for the plugin to detect changes.
`boolean`	`detectClassesChange()` It's time for the plugin to detect changes.
`void`	`enhance(ApplicationClasses.ApplicationClass applicationClass)` Enhance this class
`PlayPlugin.Filter`	`getFilter()` Return the filter implementation for this plugin.
`Collection<Class>`	`getFunctionalTests()` Implement to add some classes that should be considered functional tests but do not extend `FunctionalTest` to tests that can be executed by test runner (will be visible in test UI).
`com.google.gson.JsonObject`	`getJsonStatus()` Return the plugin status in JSON format
`String`	`getMessage(String locale, Object key, Object... args)` Translate the given key for the given locale and arguments.
`String`	`getStatus()` Return the plugin status
`Collection<Class>`	`getUnitTests()` Implement to add some classes that should be considered unit tests but do not extend `Assert` to tests that can be executed by test runner (will be visible in test UI).
`boolean`	`hasFilter()`
`void`	`invocationFinally()` Called at the end of the invocation.
`Template`	`loadTemplate(VirtualFile file)`
`Model.Factory`	`modelFactory(Class<? extends Model> modelClass)`
`void`	`onActionInvocationFinally()` Called at the end of the action invocation (either in case of success or any failure).
`void`	`onActionInvocationResult(Result result)` Called when the action method has thrown a result.
`void`	`onApplicationReady()`
`void`	`onApplicationStart()` Called at application start (and at each reloading) Time to start stateful things.
`void`	`onApplicationStop()` Called at application stop (and before each reloading) Time to shutdown stateful things.
`List<ApplicationClasses.ApplicationClass>`	`onClassesChange(List<ApplicationClasses.ApplicationClass> modified)`
`void`	`onConfigurationRead()` Called when the application.conf has been read.
`void`	`onEvent(String message, Object context)` Event may be sent by plugins or other components
`void`	`onInvocationException(Throwable e)` Called if an exception occurred during the invocation.
`void`	`onInvocationSuccess()`
`void`	`onLoad()` Called at plugin loading
`void`	`onRequestRouting(Router.Route route)` Called when the request has been routed.
`void`	`onRoutesLoaded()` Called after routes loading.
`void`	`onTemplateCompilation(Template template)` Deprecated.
`String`	`overrideTemplateSource(BaseTemplate template, String source)`
`static void`	`postEvent(String message, Object context)` Inter-plugin communication.
`boolean`	`rawInvocation(Http.Request request, Http.Response response)` Give a chance to this plugin to fully manage this request
`void`	`routeRequest(Http.Request request)` Let some plugins route themself
`TestEngine.TestResults`	`runTest(Class<BaseTest> clazz)` Run a test class
`boolean`	`serveStatic(VirtualFile file, Http.Request request, Http.Response response)` Let a chance to this plugin to manage a static resource
`Map<String,Object>`	`unBind(Object src, String name)`
`Object`	`willBeValidated(Object value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - index
```
public int index
```
    Plugin priority (0 for highest priority)
- Constructor Detail
  - PlayPlugin
```
public PlayPlugin()
```
- Method Detail
  - onLoad
```
public void onLoad()
```
    Called at plugin loading
  - compileSources
```
public boolean compileSources()
```
  - runTest
```
public TestEngine.TestResults runTest(Class<BaseTest> clazz)
```
    Run a test class
  - bind
```
@Deprecated
public Object bind(String name,
                                Class clazz,
                                Type type,
                                Annotation[] annotations,
                                Map<String,String[]> params)
```
    Deprecated.
    
    Use method using RootParamNode instead
    
    Returns:
  - bind
```
public Object bind(RootParamNode rootParamNode,
                   String name,
                   Class<?> clazz,
                   Type type,
                   Annotation[] annotations)
```
    Called when play need to bind a Java object from HTTP params. When overriding this method, do not call super impl.. super impl is calling old bind method to be backward compatible.
  - bind
```
@Deprecated
public Object bind(String name,
                                Object o,
                                Map<String,String[]> params)
```
    Deprecated.
    
    Use bindBean instead
  - bindBean
```
public Object bindBean(RootParamNode rootParamNode,
                       String name,
                       Object bean)
```
    Called when play need to bind an existing Java object from HTTP params. When overriding this method, DO NOT call the super method, since its default impl is to call the old bind method to be backward compatible.
  - unBind
```
public Map<String,Object> unBind(Object src,
                                 String name)
```
  - getMessage
```
public String getMessage(String locale,
                         Object key,
                         Object... args)
```
    Translate the given key for the given locale and arguments. If null is returned, Play's normal message translation mechanism will be used.
  - getStatus
```
public String getStatus()
```
    Return the plugin status
  - getJsonStatus
```
public com.google.gson.JsonObject getJsonStatus()
```
    Return the plugin status in JSON format
  - enhance
```
public void enhance(ApplicationClasses.ApplicationClass applicationClass)
             throws Exception
```
    Enhance this class
    
    Parameters:
    
    applicationClass -
    
    Throws:
    
    Exception
  - onTemplateCompilation
```
@Deprecated
public void onTemplateCompilation(Template template)
```
    Deprecated.
    
    This hook is not plugged, don't implement it
    
    Parameters:
    
    template -
  - rawInvocation
```
public boolean rawInvocation(Http.Request request,
                             Http.Response response)
                      throws Exception
```
    Give 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 resource
    
    Parameters:
    
    request - The Play request
    
    response - The Play response
    
    Returns:
    
    true if this plugin has managed this request
  - beforeDetectingChanges
```
public void beforeDetectingChanges()
```
  - loadTemplate
```
public Template loadTemplate(VirtualFile file)
```
  - detectChange
```
public void detectChange()
```
    It's time for the plugin to detect changes. Throw an exception is the application must be reloaded.
  - detectClassesChange
```
public boolean detectClassesChange()
```
    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 stateful 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 stateful 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 exception has been thrown). Time to close request specific things.
  - onInvocationException
```
public void onInvocationException(Throwable e)
```
    Called if an exception occurred during the invocation.
    
    Parameters:
    
    e - The caught exception.
  - invocationFinally
```
public void invocationFinally()
```
    Called at the end of the invocation. (even if an exception occurred). 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.
  - onInvocationSuccess
```
public void onInvocationSuccess()
```
  - onRequestRouting
```
public void onRequestRouting(Router.Route route)
```
    Called when the request has been routed.
    
    Parameters:
    
    route - The route selected.
  - afterActionInvocation
```
public void afterActionInvocation()
```
    Called at the end of the action invocation.
  - onActionInvocationFinally
```
public void onActionInvocationFinally()
```
    Called at the end of the action invocation (either in case of success or any failure).
  - onConfigurationRead
```
public void onConfigurationRead()
```
    Called when the application.conf 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
  - onClassesChange
```
public List<ApplicationClasses.ApplicationClass> onClassesChange(List<ApplicationClasses.ApplicationClass> modified)
```
  - addTemplateExtensions
```
public List<String> addTemplateExtensions()
```
  - addMimeTypes
```
public Map<String,String> addMimeTypes()
```
    Override to provide additional mime types from your plugin. These mimetypes get priority over the default framework mimetypes but not over the application's configuration.
    
    Returns:
    
    a Map from extensions (without dot) to mimetypes
  - compileAll
```
@Deprecated
public void compileAll(List<ApplicationClasses.ApplicationClass> classes)
```
    Deprecated.
    
    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 -
  - modelFactory
```
public Model.Factory modelFactory(Class<? extends Model> modelClass)
```
  - afterFixtureLoad
```
public void afterFixtureLoad()
```
  - postEvent
```
public static void postEvent(String message,
                             Object context)
```
    Inter-plugin communication.
  - onApplicationReady
```
public void onApplicationReady()
```
  - compareTo
```
public int compareTo(PlayPlugin o)
```
    Specified by:
    
    compareTo in interface Comparable<PlayPlugin>
  - overrideTemplateSource
```
public String overrideTemplateSource(BaseTemplate template,
                                     String source)
```
  - willBeValidated
```
public Object willBeValidated(Object value)
```
  - getUnitTests
```
public Collection<Class> getUnitTests()
```
    Implement to add some classes that should be considered unit tests but do not extend Assert to tests that can be executed by test runner (will be visible in test UI).
    Note:You probably will also need to override runTest(java.lang.Class) method to handle unsupported tests execution properly.
    Keep in mind that this method can only add tests to currently loaded ones. You cannot disable tests this way. You should also make sure you do not duplicate already loaded tests.
    
    Returns:
    
    list of plugin supported unit test classes (empty list in default implementation)
  - getFunctionalTests
```
public Collection<Class> getFunctionalTests()
```
    Implement to add some classes that should be considered functional tests but do not extend FunctionalTest to tests that can be executed by test runner (will be visible in test UI).
    Note:You probably will also need to override runTest(java.lang.Class) method to handle unsupported tests execution properly.
    Keep in mind that this method can only add tests to currently loaded ones. You cannot disable tests this way. You should also make sure you do not duplicate already loaded tests.
    
    Returns:
    
    list of plugin supported functional test classes (empty list in default implementation)
  - hasFilter
```
public final boolean hasFilter()
```
  - getFilter
```
public PlayPlugin.Filter getFilter()
```
    Return the filter implementation for this plugin.

Class PlayPlugin

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

index

Constructor Detail

PlayPlugin

Method Detail

onLoad

compileSources

runTest

bind

bind

bind

bindBean

unBind

getMessage

getStatus

getJsonStatus

enhance

onTemplateCompilation

rawInvocation

serveStatic

beforeDetectingChanges

loadTemplate

detectChange

detectClassesChange

onApplicationStart

afterApplicationStart

onApplicationStop

beforeInvocation

afterInvocation

onInvocationException

invocationFinally

beforeActionInvocation

onActionInvocationResult

onInvocationSuccess

onRequestRouting

afterActionInvocation

onActionInvocationFinally

onConfigurationRead

onRoutesLoaded

onEvent

onClassesChange

addTemplateExtensions

addMimeTypes

compileAll

routeRequest

modelFactory

afterFixtureLoad

postEvent

onApplicationReady

compareTo

overrideTemplateSource

willBeValidated

getUnitTests

getFunctionalTests

hasFilter

getFilter