org.codehaus.groovy.grails.plugins
Interface GrailsPluginManager

All Superinterfaces:

ApplicationContextAware, ServletContextAware

All Known Implementing Classes:

AbstractGrailsPluginManager, DefaultGrailsPluginManager

public interface GrailsPluginManager
extends ApplicationContextAware, ServletContextAware

A class that handles the loading and management of plug-ins in the Grails system. A plugin a just like a normal Grails application except that it contains a file ending in *Plugin.groovy in the root of the directory.

A Plugin class is a Groovy class that has a version and optionally closures called doWithSpring, doWithContext and doWithWebDescriptor

The doWithSpring closure uses the BeanBuilder syntax (@see grails.spring.BeanBuilder) to provide runtime configuration of Grails via Spring

The doWithContext closure is called after the Spring ApplicationContext is built and accepts a single argument (the ApplicationContext)

The doWithWebDescriptor uses mark-up building to provide additional functionality to the web.xml file

Example:

 class ClassEditorGrailsPlugin {
      def version = 1.1
      def doWithSpring = { application ->
        classEditor(org.springframework.beans.propertyeditors.ClassEditor, application.classLoader)
      }
 }
 

A plugin can also define "dependsOn" and "evict" properties that specify what plugins the plugin depends on and which ones it is incompatable with and should evict

Since:

0.4

Author:

Graeme Rocher

Field Summary

static String

BEAN_NAME

Method Summary

void	checkForChanges() Checks all the plugins to see whether they have any changes
void	doArtefactConfiguration() Called prior to the initialisation of the GrailsApplication object to allow registration of additional ArtefactHandler objects
void	doDynamicMethods() This is called on all plugins so that they can add new methods/properties/constructors etc.
void	doPostProcessing(ApplicationContext applicationContext) Performs post initialization configuration for each plug-in, passing the built application context
void	doRuntimeConfiguration(RuntimeSpringConfiguration springConfig) Executes the runtime configuration phase of plug-ins
void	doRuntimeConfiguration(String pluginName, RuntimeSpringConfiguration springConfig) Executes the runtime configuration for a specific plugin AND all its dependencies
void	doWebDescriptor(File descriptor, Writer target)
void	doWebDescriptor(Resource descriptor, Writer target) Takes the specified web descriptor reference and configures it with all the plugins outputting the result to the target Writer instance
GrailsPlugin[]	getAllPlugins() Returns an array of all the loaded plug-ins
GrailsPlugin[]	getFailedLoadPlugins()
GrailsPlugin	getFailedPlugin(String name) Retrieves a plug-in that failed to load, or null if it doesn't exist
GrailsPlugin	getGrailsPlugin(String name) Retrieves a name Grails plugin instance
GrailsPlugin	getGrailsPlugin(String name, Object version) Retrieves a plug-in for its name and version
GrailsPlugin	getGrailsPluginForClassName(String name) Obtains a GrailsPlugin for the given classname
Collection	getPluginObservers(GrailsPlugin plugin) Retrieves a collection of plugins that are observing the specified plugin
String	getPluginPath(String name) Returns the pluginContextPath for the given plugin
String	getPluginPathForClass(Class<? extends Object> theClass) Returns the plugin path for the given class
String	getPluginPathForInstance(Object instance) Returns the pluginContextPath for the given instance
String	getPluginViewsPathForClass(Class<? extends Object> theClass) Returns the plugin views directory path for the given class
String	getPluginViewsPathForInstance(Object instance) Returns the plugin views directory for the given instance
List<TypeFilter>	getTypeFilters() Get all of the TypeFilter definitions defined by the plugins
GrailsPlugin[]	getUserPlugins() Gets plugin installed by the user and not provided by the framework
boolean	hasGrailsPlugin(String name)
void	informObservers(String pluginName, Map event) inform the specified plugins observers of the event specified by the passed Map instance
void	informOfClassChange(Class aClass) Method for handling changes to a class and triggering on change events etc.
boolean	isInitialised()
void	loadPlugins() Performs the initial load of plug-ins throwing an exception if any dependencies don't resolve
void	refreshPlugin(String name) Refreshes the specified plugin.
void	registerProvidedArtefacts(GrailsApplication application) Registers pre-compiled artefacts with the GrailsApplication instance, only overriding if the application doesn't already provide an artefact of the same name
void	setApplication(GrailsApplication application) Sets the GrailsApplication used be this plugin manager
void	setLoadCorePlugins(boolean shouldLoadCorePlugins) Set whether the core plugins should be loaded
void	shutdown() Shuts down the PluginManager
boolean	supportsCurrentBuildScope(String pluginName) Returns true if the given plugin supports the current BuildScope

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.springframework.web.context.ServletContextAware

setServletContext

Field Detail

BEAN_NAME

static final String BEAN_NAME

See Also:

Constant Field Values

Method Detail

getAllPlugins

GrailsPlugin[] getAllPlugins()

Returns an array of all the loaded plug-ins

Returns:

An array of plug-ins

getUserPlugins

GrailsPlugin[] getUserPlugins()

Gets plugin installed by the user and not provided by the framework

Returns:

A list of user plugins

getFailedLoadPlugins

GrailsPlugin[] getFailedLoadPlugins()

Returns:

An array of plugins that failed to load due to dependency resolution errors

loadPlugins

void loadPlugins()
                 throws PluginException

Performs the initial load of plug-ins throwing an exception if any dependencies don't resolve

Throws:

PluginException - Thrown when an error occurs loading the plugins

doRuntimeConfiguration

void doRuntimeConfiguration(RuntimeSpringConfiguration springConfig)

Executes the runtime configuration phase of plug-ins

Parameters:

springConfig - The RuntimeSpringConfiguration instance

doPostProcessing

void doPostProcessing(ApplicationContext applicationContext)

Performs post initialization configuration for each plug-in, passing the built application context

Parameters:

applicationContext - The ApplicationContext instance

doWebDescriptor

void doWebDescriptor(Resource descriptor,
                     Writer target)

Takes the specified web descriptor reference and configures it with all the plugins outputting the result to the target Writer instance

Parameters:

descriptor - The Resource of the descriptor

target - The Writer to write the result to

doWebDescriptor

void doWebDescriptor(File descriptor,
                     Writer target)

Parameters:

descriptor - The File of the descriptor

target - The target to write the changes to

See Also:

doWebDescriptor(Resource, Writer)

doDynamicMethods

void doDynamicMethods()

This is called on all plugins so that they can add new methods/properties/constructors etc.

getGrailsPlugin

GrailsPlugin getGrailsPlugin(String name)

Retrieves a name Grails plugin instance

Parameters:

name - The name of the plugin

Returns:

The GrailsPlugin instance or null if it doesn't exist

getGrailsPluginForClassName

GrailsPlugin getGrailsPluginForClassName(String name)

Obtains a GrailsPlugin for the given classname

Parameters:

name - The name of the plugin

Returns:

The instance

hasGrailsPlugin

boolean hasGrailsPlugin(String name)

Parameters:

name - The name of the plugin

Returns:

True if the the manager has a loaded plugin with the given name

getFailedPlugin

GrailsPlugin getFailedPlugin(String name)

Retrieves a plug-in that failed to load, or null if it doesn't exist

Parameters:

name - The name of the plugin

Returns:

A GrailsPlugin or null

getGrailsPlugin

GrailsPlugin getGrailsPlugin(String name,
                             Object version)

Retrieves a plug-in for its name and version

Parameters:

name - The name of the plugin

version - The version of the plugin

Returns:

The GrailsPlugin instance or null if it doesn't exist

doRuntimeConfiguration

void doRuntimeConfiguration(String pluginName,
                            RuntimeSpringConfiguration springConfig)

Executes the runtime configuration for a specific plugin AND all its dependencies

Parameters:

pluginName - The name of he plugin

springConfig - The runtime spring config instance

checkForChanges

void checkForChanges()

Checks all the plugins to see whether they have any changes

setApplication

void setApplication(GrailsApplication application)

Sets the GrailsApplication used be this plugin manager

Parameters:

application - The GrailsApplication instance

isInitialised

boolean isInitialised()

Returns:

the initialised

refreshPlugin

void refreshPlugin(String name)

Refreshes the specified plugin. A refresh will force to plugin to "touch" each of its watched resources and fire modified events for each

Parameters:

name - The name of the plugin to refresh

getPluginObservers

Collection getPluginObservers(GrailsPlugin plugin)

Retrieves a collection of plugins that are observing the specified plugin

Parameters:

plugin - The plugin to retrieve observers for

Returns:

A collection of observers

informObservers

void informObservers(String pluginName,
                     Map event)

inform the specified plugins observers of the event specified by the passed Map instance

Parameters:

pluginName - The name of the plugin

event - The event

doArtefactConfiguration

void doArtefactConfiguration()

Called prior to the initialisation of the GrailsApplication object to allow registration of additional ArtefactHandler objects

See Also:

ArtefactHandler

registerProvidedArtefacts

void registerProvidedArtefacts(GrailsApplication application)

Registers pre-compiled artefacts with the GrailsApplication instance, only overriding if the application doesn't already provide an artefact of the same name

Parameters:

application - The GrailsApplication object

shutdown

void shutdown()

Shuts down the PluginManager

supportsCurrentBuildScope

boolean supportsCurrentBuildScope(String pluginName)

Returns true if the given plugin supports the current BuildScope

Parameters:

pluginName - The name of the plugin

Returns:

True if the plugin supports the current build scope

See Also:

BuildScope.getCurrent()

setLoadCorePlugins

void setLoadCorePlugins(boolean shouldLoadCorePlugins)

Set whether the core plugins should be loaded

Parameters:

shouldLoadCorePlugins - True if they should

informOfClassChange

void informOfClassChange(Class aClass)

Method for handling changes to a class and triggering on change events etc.

Parameters:

aClass - The class

getTypeFilters

List<TypeFilter> getTypeFilters()

Get all of the TypeFilter definitions defined by the plugins

Returns:

A list of TypeFilter definitions

getPluginPath

String getPluginPath(String name)

Returns the pluginContextPath for the given plugin

Parameters:

name - The plugin name

Returns:

the context path

getPluginPathForInstance

String getPluginPathForInstance(Object instance)

Returns the pluginContextPath for the given instance

Parameters:

instance - The instance

Returns:

The pluginContextPath

getPluginPathForClass

String getPluginPathForClass(Class<? extends Object> theClass)

Returns the plugin path for the given class

Parameters:

theClass - The class

Returns:

The pluginContextPath

getPluginViewsPathForInstance

String getPluginViewsPathForInstance(Object instance)

Returns the plugin views directory for the given instance

Parameters:

instance - The instance

Returns:

The pluginContextPath

getPluginViewsPathForClass

String getPluginViewsPathForClass(Class<? extends Object> theClass)

Returns the plugin views directory path for the given class

Parameters:

theClass - The class

Returns:

The pluginContextPath