Package play.plugins

Class PluginCollection

java.lang.Object

play.plugins.PluginCollection

@NullMarked
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.

Constructor Summary

Constructors

Constructor	Description
PluginCollection()
PluginCollection(SortedSet<PluginDescriptor> pluginsToLoad)

Method Summary

Modifier and Type	Method	Description
protected void	addPlugin(PlayPlugin plugin)	Adds one plugin and enables it
void	afterActionInvocation(Http.Request request, Http.Response response, Scope.Session session, Scope.Flash flash)
void	afterApplicationStart()
void	afterInvocation()
void	beforeActionInvocation(Http.Request request, Http.Response response, Scope.Session session, Scope.RenderArgs renderArgs, Scope.Flash flash, Method actionMethod)
void	beforeInvocation()
Optional<Object>	bind(Http.Request request, Scope.Session session, RootParamNode rootParamNode, String name, Class<?> clazz, Type type, Annotation[] annotations)
void	detectChange()
Stream<PlayPlugin>	getAllPlugins()	Returns new readonly list of all plugins
Stream<PlayPlugin>	getEnabledPlugins()
Optional<String>	getMessage(String locale, Object key, Object... args)
<T extends PlayPlugin> @Nullable T	getPluginInstance(Class<T> pluginClazz)	Returns the first instance of a loaded plugin of specified type
void	loadPlugins()	Load plugins from .plugin files, if any
void	loadPlugins(SortedSet<PluginDescriptor> pluginsToLoad)
Optional<Template>	loadTemplate(File file)
void	onActionInvocationException(Http.Request request, Http.Response response, Throwable e)
void	onActionInvocationFinally(Http.Request request, Http.Response response)
void	onActionInvocationResult(Http.Request request, Http.Response response, Scope.Session session, Scope.Flash flash, Scope.RenderArgs renderArgs, Result result)
void	onApplicationStart()
void	onApplicationStop()
void	onConfigurationRead()
void	onInvocationSuccess()
void	onJobInvocationException(Throwable e)
void	onJobInvocationFinally()
boolean	rawInvocation(Http.Request request, Http.Response response, @Nullable Scope.Session session, Scope.RenderArgs renderArgs, @Nullable Scope.Flash flash)
void	routeRequest(Http.Request request)

Methods inherited from class java.lang.Object

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

Constructor Details

PluginCollection

public PluginCollection()

PluginCollection

public PluginCollection(SortedSet<PluginDescriptor> pluginsToLoad)

Method Details

loadPlugins

public void loadPlugins()

Load plugins from .plugin files, if any

loadPlugins

public void loadPlugins(SortedSet<PluginDescriptor> pluginsToLoad)

addPlugin

protected void addPlugin(PlayPlugin plugin)

Adds one plugin and enables it

Parameters:

plugin - The given plugin

getPluginInstance

public <T extends PlayPlugin> @Nullable T getPluginInstance(Class<T> pluginClazz)

Returns the first instance of a loaded plugin of specified type

Parameters:

pluginClazz - The plugin class

Returns:

PlayPlugin

getEnabledPlugins

public Stream<PlayPlugin> getEnabledPlugins()

getAllPlugins

public Stream<PlayPlugin> getAllPlugins()

Returns new readonly list of all plugins

Returns:

List of plugins

onJobInvocationFinally

public void onJobInvocationFinally()

beforeInvocation

public void beforeInvocation()

afterInvocation

public void afterInvocation()

onInvocationSuccess

public void onInvocationSuccess()

onActionInvocationException

public void onActionInvocationException(Http.Request request,
 Http.Response response,
 Throwable e)

onJobInvocationException

public void onJobInvocationException(Throwable e)

detectChange

public void detectChange()

onConfigurationRead

public void onConfigurationRead()

onApplicationStart

public void onApplicationStart()

afterApplicationStart

public void afterApplicationStart()

onApplicationStop

public void onApplicationStop()

bind

public Optional<Object> bind(Http.Request request,
 Scope.Session session,
 RootParamNode rootParamNode,
 String name,
 Class<?> clazz,
 Type type,
 Annotation[] annotations)

getMessage

public Optional<String> getMessage(String locale,
 Object key,
 Object... args)

beforeActionInvocation

public void beforeActionInvocation(Http.Request request,
 Http.Response response,
 Scope.Session session,
 Scope.RenderArgs renderArgs,
 Scope.Flash flash,
 Method actionMethod)

onActionInvocationResult

public void onActionInvocationResult(Http.Request request,
 Http.Response response,
 Scope.Session session,
 Scope.Flash flash,
 Scope.RenderArgs renderArgs,
 Result result)

afterActionInvocation

public void afterActionInvocation(Http.Request request,
 Http.Response response,
 Scope.Session session,
 Scope.Flash flash)

onActionInvocationFinally

public void onActionInvocationFinally(Http.Request request,
 Http.Response response)

routeRequest

public void routeRequest(Http.Request request)

rawInvocation

public boolean rawInvocation(Http.Request request,
 Http.Response response,
 @Nullable Scope.Session session,
 Scope.RenderArgs renderArgs,
 @Nullable Scope.Flash flash)

loadTemplate

public Optional<Template> loadTemplate(File file)