play.plugins

Class PluginCollection

java.lang.Object

play.plugins.PluginCollection

public class PluginCollection
extends Object

Class handling all plugins used by Play. Loading/reloading/enabling/disabling is handled here. This class also exposes many PlayPlugin-methods which when called, the method is executed on all enabled plugins. Since all the enabled-plugins-iteration is done here, the code elsewhere is cleaner.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<PlayPlugin>	allPlugins List that holds all loaded plugins, enabled or disabled
protected List<PlayPlugin>	allPlugins_readOnlyCopy Readonly copy of allPlugins - updated each time allPlugins is updated.
protected List<PlayPlugin>	enabledPlugins List of all enabled plugins
protected List<PlayPlugin>	enabledPlugins_readOnlyCopy Readonly copy of enabledPlugins - updated each time enabledPlugins is updated.
protected List<PlayPlugin>	enabledPluginsWithFilters List of all enabled plugins with filters
protected List<PlayPlugin>	enabledPluginsWithFilters_readOnlyCopy Readonly copy of enabledPluginsWithFilters - updated each time enabledPluginsWithFilters is updated.
protected String	play_plugins_resourceName Property holding the name of the play.plugins-resource-name.

Constructor Summary

Constructors

Constructor and Description
PluginCollection()

Method Summary

Modifier and Type	Method and Description
protected boolean	addPlugin(PlayPlugin plugin) Adds one plugin and enables it
List<String>	addTemplateExtensions()
void	afterActionInvocation()
void	afterApplicationStart()
void	afterFixtureLoad()
void	afterInvocation()
void	beforeActionInvocation(Method actionMethod)
void	beforeDetectingChanges()
void	beforeInvocation()
Object	bind(RootParamNode rootParamNode, String name, Class<?> clazz, Type type, Annotation[] annotations)
Object	bindBean(RootParamNode rootParamNode, String name, Object bean)
void	compileAll(List<ApplicationClasses.ApplicationClass> classes) Deprecated.
boolean	compileSources()
<T> F.Option<PlayPlugin.Filter<T>>	composeFilters()
protected List<PlayPlugin>	createReadonlyCopy(List<PlayPlugin> list) Using readonly list to crash if someone tries to modify the copy.
void	detectChange()
boolean	detectClassesChange()
boolean	disablePlugin(Class<? extends PlayPlugin> pluginClazz) disable plugin of specified type
boolean	disablePlugin(PlayPlugin plugin) disable plugin
boolean	enablePlugin(Class<? extends PlayPlugin> pluginClazz) enable plugin of specified type
boolean	enablePlugin(PlayPlugin plugin) Enable plugin.
void	enhance(ApplicationClasses.ApplicationClass applicationClass)
List<PlayPlugin>	getAllPlugins() Returns new readonly list of all plugins
List<PlayPlugin>	getEnabledPlugins() Returns new readonly list of all enabled plugins
List<PlayPlugin>	getEnabledPluginsWithFilters() Returns new readonly list of all enabled plugins that define filters.
Collection<Class>	getFunctionalTests()
String	getMessage(String locale, Object key, Object... args)
PlayPlugin	getPluginInstance(Class<? extends PlayPlugin> pluginClazz) Returns the first instance of a loaded plugin of specified type
Collection<PlayPlugin>	getReversedEnabledPlugins() Returns readonly view of all enabled plugins in reversed order
Collection<Class>	getUnitTests()
protected void	initializePlugin(PlayPlugin plugin) Calls plugin.onLoad but detects if plugin removes other plugins from Play.plugins-list to detect if plugins disables a plugin the old hacked way..
void	invocationFinally()
boolean	isEnabled(PlayPlugin plugin)
protected boolean	isLoadedByApplicationClassloader(PlayPlugin plugin)
void	loadPlugins() Enable found plugins
Template	loadTemplate(VirtualFile file)
Model.Factory	modelFactory(Class<? extends Model> modelClass)
void	onActionInvocationFinally()
void	onActionInvocationResult(Result result)
void	onApplicationReady()
void	onApplicationStart()
void	onApplicationStop()
List<ApplicationClasses.ApplicationClass>	onClassesChange(List<ApplicationClasses.ApplicationClass> modified) Deprecated.
void	onConfigurationRead()
void	onEvent(String message, Object context)
void	onInvocationException(Throwable e)
void	onInvocationSuccess()
void	onRequestRouting(Router.Route route)
void	onRoutesLoaded()
String	overrideTemplateSource(BaseTemplate template, String source)
boolean	rawInvocation(Http.Request request, Http.Response response)
void	reloadApplicationPlugins() Reloads all loaded plugins that is application-supplied.
protected void	replacePlugin(PlayPlugin oldPlugin, PlayPlugin newPlugin)
void	routeRequest(Http.Request request)
TestEngine.TestResults	runTest(Class<BaseTest> clazz)
boolean	serveStatic(VirtualFile file, Http.Request request, Http.Response response)
Map<String,Object>	unBind(Object src, String name)
void	updatePlayPluginsList() Must update Play.plugins-list to be backward compatible
Object	willBeValidated(Object value)

Methods inherited from class java.lang.Object

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

Field Detail

play_plugins_resourceName

protected String play_plugins_resourceName

Property holding the name of the play.plugins-resource-name. Can be modified in unittest to supply modifies plugin-list

allPlugins

protected List<PlayPlugin> allPlugins

List that holds all loaded plugins, enabled or disabled

allPlugins_readOnlyCopy

protected List<PlayPlugin> allPlugins_readOnlyCopy

Readonly copy of allPlugins - updated each time allPlugins is updated. Using this cached copy so we don't have to create it all the time..

enabledPlugins

protected List<PlayPlugin> enabledPlugins

List of all enabled plugins

enabledPlugins_readOnlyCopy

protected List<PlayPlugin> enabledPlugins_readOnlyCopy

Readonly copy of enabledPlugins - updated each time enabledPlugins is updated. Using this cached copy so we don't have to create it all the time

enabledPluginsWithFilters

protected List<PlayPlugin> enabledPluginsWithFilters

List of all enabled plugins with filters

enabledPluginsWithFilters_readOnlyCopy

protected List<PlayPlugin> enabledPluginsWithFilters_readOnlyCopy

Readonly copy of enabledPluginsWithFilters - updated each time enabledPluginsWithFilters is updated. Using this cached copy so we don't have to create it all the time

Constructor Detail

PluginCollection

public PluginCollection()

Method Detail

createReadonlyCopy

protected List<PlayPlugin> createReadonlyCopy(List<PlayPlugin> list)

Using readonly list to crash if someone tries to modify the copy.

Parameters:

list -

Returns:

Read only list of plugins

loadPlugins

public void loadPlugins()

Enable found plugins

reloadApplicationPlugins

public void reloadApplicationPlugins()
                              throws Exception

Reloads all loaded plugins that is application-supplied.

Throws:

Exception

isLoadedByApplicationClassloader

protected boolean isLoadedByApplicationClassloader(PlayPlugin plugin)

initializePlugin

protected void initializePlugin(PlayPlugin plugin)

Calls plugin.onLoad but detects if plugin removes other plugins from Play.plugins-list to detect if plugins disables a plugin the old hacked way..

Parameters:

plugin -

addPlugin

protected boolean addPlugin(PlayPlugin plugin)

Adds one plugin and enables it

Parameters:

plugin -

Returns:

true if plugin was new and was added

replacePlugin

protected void replacePlugin(PlayPlugin oldPlugin,
                             PlayPlugin newPlugin)

enablePlugin

public boolean enablePlugin(PlayPlugin plugin)

Enable plugin.

Parameters:

plugin -

Returns:

true if plugin exists and was enabled now

enablePlugin

public boolean enablePlugin(Class<? extends PlayPlugin> pluginClazz)

enable plugin of specified type

Returns:

true if plugin was enabled

getPluginInstance

public PlayPlugin getPluginInstance(Class<? extends PlayPlugin> pluginClazz)

Returns the first instance of a loaded plugin of specified type

Parameters:

pluginClazz -

Returns:

PlayPlugin

disablePlugin

public boolean disablePlugin(PlayPlugin plugin)

disable plugin

Parameters:

plugin -

Returns:

true if plugin was enabled and now is disabled

disablePlugin

public boolean disablePlugin(Class<? extends PlayPlugin> pluginClazz)

disable plugin of specified type

Returns:

true if plugin was enabled and now is disabled

updatePlayPluginsList

public void updatePlayPluginsList()

Must update Play.plugins-list to be backward compatible

getEnabledPlugins

public List<PlayPlugin> getEnabledPlugins()

Returns new readonly list of all enabled plugins

Returns:

List of plugins

getEnabledPluginsWithFilters

public List<PlayPlugin> getEnabledPluginsWithFilters()

Returns new readonly list of all enabled plugins that define filters.

Returns:

List of plugins

composeFilters

public <T> F.Option<PlayPlugin.Filter<T>> composeFilters()

getReversedEnabledPlugins

public Collection<PlayPlugin> getReversedEnabledPlugins()

Returns readonly view of all enabled plugins in reversed order

Returns:

Collection of plugins

getAllPlugins

public List<PlayPlugin> getAllPlugins()

Returns new readonly list of all plugins

Returns:

List of plugins

isEnabled

public boolean isEnabled(PlayPlugin plugin)

Parameters:

plugin -

Returns:

true if plugin is enabled

compileSources

public boolean compileSources()

detectClassesChange

public boolean detectClassesChange()

invocationFinally

public void invocationFinally()

beforeInvocation

public void beforeInvocation()

afterInvocation

public void afterInvocation()

onInvocationSuccess

public void onInvocationSuccess()

onInvocationException

public void onInvocationException(Throwable e)

beforeDetectingChanges

public void beforeDetectingChanges()

detectChange

public void detectChange()

onApplicationReady

public void onApplicationReady()

onConfigurationRead

public void onConfigurationRead()

onApplicationStart

public void onApplicationStart()

afterApplicationStart

public void afterApplicationStart()

onApplicationStop

public void onApplicationStop()

onEvent

public void onEvent(String message,
                    Object context)

enhance

public void enhance(ApplicationClasses.ApplicationClass applicationClass)

onClassesChange

@Deprecated
public List<ApplicationClasses.ApplicationClass> onClassesChange(List<ApplicationClasses.ApplicationClass> modified)

Deprecated.

compileAll

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

Deprecated.

bind

public Object bind(RootParamNode rootParamNode,
                   String name,
                   Class<?> clazz,
                   Type type,
                   Annotation[] annotations)

bindBean

public Object bindBean(RootParamNode rootParamNode,
                       String name,
                       Object bean)

unBind

public Map<String,Object> unBind(Object src,
                                 String name)

willBeValidated

public Object willBeValidated(Object value)

modelFactory

public Model.Factory modelFactory(Class<? extends Model> modelClass)

getMessage

public String getMessage(String locale,
                         Object key,
                         Object... args)

beforeActionInvocation

public void beforeActionInvocation(Method actionMethod)

onActionInvocationResult

public void onActionInvocationResult(Result result)

afterActionInvocation

public void afterActionInvocation()

onActionInvocationFinally

public void onActionInvocationFinally()

routeRequest

public void routeRequest(Http.Request request)

onRequestRouting

public void onRequestRouting(Router.Route route)

onRoutesLoaded

public void onRoutesLoaded()

rawInvocation

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

Throws:

Exception

serveStatic

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

addTemplateExtensions

public List<String> addTemplateExtensions()

overrideTemplateSource

public String overrideTemplateSource(BaseTemplate template,
                                     String source)

loadTemplate

public Template loadTemplate(VirtualFile file)

afterFixtureLoad

public void afterFixtureLoad()

runTest

public TestEngine.TestResults runTest(Class<BaseTest> clazz)

getUnitTests

public Collection<Class> getUnitTests()

getFunctionalTests

public Collection<Class> getFunctionalTests()