org.codehaus.groovy.grails.plugins

Class DefaultGrailsPluginManager

java.lang.Object

org.codehaus.groovy.grails.plugins.AbstractGrailsPluginManager

org.codehaus.groovy.grails.plugins.DefaultGrailsPluginManager

All Implemented Interfaces:

GrailsPluginManager, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ProfilingGrailsPluginManager

public class DefaultGrailsPluginManager
extends AbstractGrailsPluginManager

Handles the loading and management of plug-ins in the Grails system. A plugin is 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 incompatible with and should evict

Since:

0.4

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Class<?>[]	COMMON_CLASSES

Fields inherited from class org.codehaus.groovy.grails.plugins.AbstractGrailsPluginManager

application, applicationContext, classNameToPluginMap, CONFIG_FILE, failedPlugins, initialised, loadCorePlugins, pluginClasses, pluginList, pluginResources, plugins, shutdown

Fields inherited from interface org.codehaus.groovy.grails.plugins.GrailsPluginManager

BEAN_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultGrailsPluginManager(java.lang.Class<?>[] plugins, GrailsApplication application)
DefaultGrailsPluginManager(org.springframework.core.io.Resource[] pluginFiles, GrailsApplication application)
DefaultGrailsPluginManager(java.lang.String[] pluginResources, GrailsApplication application)
DefaultGrailsPluginManager(java.lang.String resourcePath, GrailsApplication application)

Method Summary

Modifier and Type	Method and Description
protected boolean	canRegisterPlugin(GrailsPlugin plugin)
void	checkForChanges() Deprecated. Replaced by agent-based reloading, will be removed in a future version of Grails
protected GrailsPlugin	createGrailsPlugin(java.lang.Class<?> pluginClass)
protected GrailsPlugin	createGrailsPlugin(java.lang.Class<?> pluginClass, org.springframework.core.io.Resource resource)
void	doDynamicMethods() Called on all plugins so that they can add new methods/properties/constructors etc.
void	doWebDescriptor(java.io.File descriptor, java.io.Writer target)
void	doWebDescriptor(org.springframework.core.io.Resource descriptor, java.io.Writer target) Takes the specified web descriptor reference and configures it with all the plugins outputting the result to the target Writer instance
protected void	evictPlugin(GrailsPlugin evictor, java.lang.String evicteeName)
java.util.Collection<GrailsPlugin>	getPluginObservers(GrailsPlugin plugin) Retrieves a collection of plugins that are observing the specified plugin
GrailsPlugin[]	getUserPlugins() Gets plugin installed by the user and not provided by the framework
void	informObservers(java.lang.String pluginName, java.util.Map event) inform the specified plugins observers of the event specified by the passed Map instance
void	loadPlugins() Performs the initial load of plug-ins throwing an exception if any dependencies don't resolve
void	refreshPlugin(java.lang.String name) Refreshes the specified plugin.
void	reloadPlugin(GrailsPlugin plugin)
protected java.util.Map<GrailsPlugin,java.util.List<GrailsPlugin>>	resolveLoadDependencies(java.util.List<GrailsPlugin> plugins)
void	setApplication(GrailsApplication application) Sets the GrailsApplication used be this plugin manager
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setParentApplicationContext(org.springframework.context.ApplicationContext parent)
protected java.util.List<GrailsPlugin>	sortPlugins(java.util.List<GrailsPlugin> toSort)
void	startPluginChangeScanner() Deprecated. Will be removed in a future version of Grails
void	stopPluginChangeScanner() Deprecated. Will be removed in a future version of Grails

Methods inherited from class org.codehaus.groovy.grails.plugins.AbstractGrailsPluginManager

checkInitialised, doArtefactConfiguration, doPostProcessing, doRuntimeConfiguration, doRuntimeConfiguration, getAllPlugins, getFailedLoadPlugins, getFailedPlugin, getGrailsPlugin, getGrailsPlugin, getGrailsPluginForClassName, getPluginForClass, getPluginForInstance, getPluginPath, getPluginPathForClass, getPluginPathForInstance, getPluginResources, getPluginViewsPathForClass, getPluginViewsPathForInstance, getTypeFilters, hasGrailsPlugin, informOfClassChange, informOfClassChange, informOfFileChange, informPluginsOfConfigChange, isInitialised, isShutdown, registerProvidedArtefacts, setLoadCorePlugins, shutdown, supportsCurrentBuildScope

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_CLASSES

protected static final java.lang.Class<?>[] COMMON_CLASSES

Constructor Detail

DefaultGrailsPluginManager

public DefaultGrailsPluginManager(java.lang.String resourcePath,
                                  GrailsApplication application)

DefaultGrailsPluginManager

public DefaultGrailsPluginManager(java.lang.String[] pluginResources,
                                  GrailsApplication application)

DefaultGrailsPluginManager

public DefaultGrailsPluginManager(java.lang.Class<?>[] plugins,
                                  GrailsApplication application)

DefaultGrailsPluginManager

public DefaultGrailsPluginManager(org.springframework.core.io.Resource[] pluginFiles,
                                  GrailsApplication application)

Method Detail

getUserPlugins

public GrailsPlugin[] getUserPlugins()

Description copied from interface: GrailsPluginManager

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

Returns:

A list of user plugins

startPluginChangeScanner

@Deprecated
public void startPluginChangeScanner()

Deprecated. Will be removed in a future version of Grails

stopPluginChangeScanner

@Deprecated
public void stopPluginChangeScanner()

Deprecated. Will be removed in a future version of Grails

refreshPlugin

public void refreshPlugin(java.lang.String name)

Description copied from interface: GrailsPluginManager

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

public java.util.Collection<GrailsPlugin> getPluginObservers(GrailsPlugin plugin)

Description copied from interface: GrailsPluginManager

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

public void informObservers(java.lang.String pluginName,
                            java.util.Map event)

Description copied from interface: GrailsPluginManager

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

Parameters:

pluginName - The name of the plugin

event - The event

loadPlugins

public void loadPlugins()
                 throws org.codehaus.groovy.grails.plugins.exceptions.PluginException

Description copied from interface: GrailsPluginManager

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

Throws:

org.codehaus.groovy.grails.plugins.exceptions.PluginException - Thrown when an error occurs loading the plugins

sortPlugins

protected java.util.List<GrailsPlugin> sortPlugins(java.util.List<GrailsPlugin> toSort)

resolveLoadDependencies

protected java.util.Map<GrailsPlugin,java.util.List<GrailsPlugin>> resolveLoadDependencies(java.util.List<GrailsPlugin> plugins)

createGrailsPlugin

protected GrailsPlugin createGrailsPlugin(java.lang.Class<?> pluginClass)

createGrailsPlugin

protected GrailsPlugin createGrailsPlugin(java.lang.Class<?> pluginClass,
                                          org.springframework.core.io.Resource resource)

canRegisterPlugin

protected boolean canRegisterPlugin(GrailsPlugin plugin)

evictPlugin

protected void evictPlugin(GrailsPlugin evictor,
                           java.lang.String evicteeName)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Overrides:

setApplicationContext in class AbstractGrailsPluginManager

Throws:

org.springframework.beans.BeansException

setParentApplicationContext

public void setParentApplicationContext(org.springframework.context.ApplicationContext parent)

checkForChanges

@Deprecated
public void checkForChanges()

Deprecated. Replaced by agent-based reloading, will be removed in a future version of Grails

Description copied from interface: GrailsPluginManager

Checks all the plugins to see whether they have any changes

reloadPlugin

public void reloadPlugin(GrailsPlugin plugin)

doWebDescriptor

public void doWebDescriptor(org.springframework.core.io.Resource descriptor,
                            java.io.Writer target)

Description copied from interface: GrailsPluginManager

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

public void doWebDescriptor(java.io.File descriptor,
                            java.io.Writer target)

Parameters:

descriptor - The File of the descriptor

target - The target to write the changes to

See Also:

GrailsPluginManager.doWebDescriptor(Resource, Writer)

setApplication

public void setApplication(GrailsApplication application)

Description copied from interface: GrailsPluginManager

Sets the GrailsApplication used be this plugin manager

Specified by:

setApplication in interface GrailsPluginManager

Overrides:

setApplication in class AbstractGrailsPluginManager

Parameters:

application - The GrailsApplication instance

doDynamicMethods

public void doDynamicMethods()

Description copied from interface: GrailsPluginManager

Called on all plugins so that they can add new methods/properties/constructors etc.

Specified by:

doDynamicMethods in interface GrailsPluginManager

Overrides:

doDynamicMethods in class AbstractGrailsPluginManager