DefaultGrailsPluginManager (Grace Framework

grails.plugins.DefaultGrailsPluginManager

```
public class DefaultGrailsPluginManager
extends AbstractGrailsPluginManager
```
Handles the loading and management of plugins 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 Also:
BeanBuilder<p<p<p<p<p/> <p>>>>>
Authors:
Graeme Rocher
Since:
0.4

Field Summary

Fields
Modifiers	Name	Description
`protected static Class<?>[]`	`COMMON_CLASSES`

Inherited fields
Fields inherited from class	Fields
`class AbstractGrailsPluginManager`	`CONFIG_FILE, application, applicationContext, classNameToPluginMap, failedPlugins, initialised, loadCorePlugins, loadedPlugins, moduleDescriptorFactory, pluginClasses, pluginResources, plugins, shutdown`

Constructor Summary

Constructors
Constructor and description
`DefaultGrailsPluginManager(String resourcePath, GrailsApplication application)`
`DefaultGrailsPluginManager(String[] pluginResources, GrailsApplication application)`
`DefaultGrailsPluginManager(Class<?>[] plugins, GrailsApplication application)`
`DefaultGrailsPluginManager(Resource[] pluginFiles, GrailsApplication application)`
`DefaultGrailsPluginManager(GrailsApplication application)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected boolean`	`canRegisterPlugin(GrailsPlugin plugin)`
	`public void`	`checkForChanges()` deprecated: Replaced by agent-based reloading, will be removed in a future version of Grails
	`protected GrailsPlugin`	`createGrailsPlugin(Class<?> pluginClass)`
	`protected GrailsPlugin`	`createGrailsPlugin(Class<?> pluginClass, Resource resource)`
	`public void`	`doDynamicMethods()`
	`protected void`	`evictPlugin(GrailsPlugin evictor, String evicteeName)`
	`public List<GrailsPlugin>`	`getPluginList()`
	`public Collection<GrailsPlugin>`	`getPluginObservers(GrailsPlugin plugin)`
	`public GrailsPlugin[]`	`getUserPlugins()`
	`public void`	`informObservers(String pluginName, Map<String, Object> event)`
	`public void`	`loadPlugins()`
	`public void`	`refreshPlugin(String name)`
	`public void`	`reloadPlugin(GrailsPlugin plugin)`
	`protected Map<GrailsPlugin, List<GrailsPlugin>>`	`resolveLoadDependencies(List<GrailsPlugin> plugins)`
	`public void`	`setApplication(GrailsApplication application)`
	`public void`	`setParentApplicationContext(ApplicationContext parent)`
	`public void`	`setPluginFilter(PluginFilter pluginFilter)`
	`protected List<GrailsPlugin>`	`sortPlugins(List<GrailsPlugin> toSort)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractGrailsPluginManager`	addUserPlugin, checkInitialised, convert, doArtefactConfiguration, doDynamicMethods, doDynamicModules, doPostProcessing, doRuntimeConfiguration, doRuntimeConfiguration, getAllPlugins, getApplication, getApplicationStartup, getEnabledModuleDescriptorsByClass, getFailedLoadPlugins, getFailedPlugin, getGrailsPlugin, getGrailsPlugin, getGrailsPluginForClassName, getModuleDescriptors, getModuleDescriptors, getPluginForClass, getPluginForInstance, getPluginPath, getPluginPath, getPluginPathForClass, getPluginPathForInstance, getPluginResources, getPluginViewsPathForClass, getPluginViewsPathForInstance, hasGrailsPlugin, informOfClassChange, informOfClassChange, informOfFileChange, informPluginsOfConfigChange, isInitialised, isPluginDisabledForProfile, isShutdown, onStartup, registerProvidedArtefacts, registerProvidedModules, setApplication, setApplicationContext, setApplicationStartup, setLoadCorePlugins, setPluginFilter, shutdown

- Field Detail
  - protected static final Class<?>[] COMMON_CLASSES
- Constructor Detail
  - public DefaultGrailsPluginManager(String resourcePath, GrailsApplication application)
  - public DefaultGrailsPluginManager(String[] pluginResources, GrailsApplication application)
  - public DefaultGrailsPluginManager(Class<?>[] plugins, GrailsApplication application)
  - public DefaultGrailsPluginManager(Resource[] pluginFiles, GrailsApplication application)
  - public DefaultGrailsPluginManager(GrailsApplication application)
- Method Detail
  - protected boolean canRegisterPlugin(GrailsPlugin plugin)
  - @Deprecated
    public void checkForChanges()
    
    deprecated:
    Replaced by agent-based reloading, will be removed in a future version of Grails
  - protected GrailsPlugin createGrailsPlugin(Class<?> pluginClass)
  - protected GrailsPlugin createGrailsPlugin(Class<?> pluginClass, Resource resource)
  - @Override
    public void doDynamicMethods()
  - protected void evictPlugin(GrailsPlugin evictor, String evicteeName)
  - public List<GrailsPlugin> getPluginList()
  - public Collection<GrailsPlugin> getPluginObservers(GrailsPlugin plugin)
  - public GrailsPlugin[] getUserPlugins()
  - public void informObservers(String pluginName, Map<String, Object> event)
  - public void loadPlugins()
  - public void refreshPlugin(String name)
  - public void reloadPlugin(GrailsPlugin plugin)
  - protected Map<GrailsPlugin, List<GrailsPlugin>> resolveLoadDependencies(List<GrailsPlugin> plugins)
  - @Override
    public void setApplication(GrailsApplication application)
  - public void setParentApplicationContext(ApplicationContext parent)
  - public void setPluginFilter(PluginFilter pluginFilter)
  - protected List<GrailsPlugin> sortPlugins(List<GrailsPlugin> toSort)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class DefaultGrailsPluginManager

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final Class<?>[] COMMON_CLASSES

Constructor Detail

public DefaultGrailsPluginManager(String resourcePath, GrailsApplication application)

public DefaultGrailsPluginManager(String[] pluginResources, GrailsApplication application)

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

public DefaultGrailsPluginManager(Resource[] pluginFiles, GrailsApplication application)

public DefaultGrailsPluginManager(GrailsApplication application)

Method Detail

protected boolean canRegisterPlugin(GrailsPlugin plugin)

@Deprecated
public void checkForChanges()

protected GrailsPlugin createGrailsPlugin(Class<?> pluginClass)

protected GrailsPlugin createGrailsPlugin(Class<?> pluginClass, Resource resource)

@Override
public void doDynamicMethods()

protected void evictPlugin(GrailsPlugin evictor, String evicteeName)

public List<GrailsPlugin> getPluginList()

public Collection<GrailsPlugin> getPluginObservers(GrailsPlugin plugin)

public GrailsPlugin[] getUserPlugins()

public void informObservers(String pluginName, Map<String, Object> event)

public void loadPlugins()

public void refreshPlugin(String name)

public void reloadPlugin(GrailsPlugin plugin)

protected Map<GrailsPlugin, List<GrailsPlugin>> resolveLoadDependencies(List<GrailsPlugin> plugins)

@Override
public void setApplication(GrailsApplication application)

public void setParentApplicationContext(ApplicationContext parent)

public void setPluginFilter(PluginFilter pluginFilter)

protected List<GrailsPlugin> sortPlugins(List<GrailsPlugin> toSort)

[Java] Class DefaultGrailsPluginManager

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final Class<?>[] COMMON_CLASSES

Constructor Detail

public DefaultGrailsPluginManager(String resourcePath, GrailsApplication application)

public DefaultGrailsPluginManager(String[] pluginResources, GrailsApplication application)

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

public DefaultGrailsPluginManager(Resource[] pluginFiles, GrailsApplication application)

public DefaultGrailsPluginManager(GrailsApplication application)

Method Detail

protected boolean canRegisterPlugin(GrailsPlugin plugin)

@Deprecatedpublic void checkForChanges()

protected GrailsPlugin createGrailsPlugin(Class<?> pluginClass)

protected GrailsPlugin createGrailsPlugin(Class<?> pluginClass, Resource resource)

@Overridepublic void doDynamicMethods()

protected void evictPlugin(GrailsPlugin evictor, String evicteeName)

public List<GrailsPlugin> getPluginList()

public Collection<GrailsPlugin> getPluginObservers(GrailsPlugin plugin)

public GrailsPlugin[] getUserPlugins()

public void informObservers(String pluginName, Map<String, Object> event)

public void loadPlugins()

public void refreshPlugin(String name)

public void reloadPlugin(GrailsPlugin plugin)

protected Map<GrailsPlugin, List<GrailsPlugin>> resolveLoadDependencies(List<GrailsPlugin> plugins)

@Overridepublic void setApplication(GrailsApplication application)

public void setParentApplicationContext(ApplicationContext parent)

public void setPluginFilter(PluginFilter pluginFilter)

protected List<GrailsPlugin> sortPlugins(List<GrailsPlugin> toSort)

@Deprecated
public void checkForChanges()

@Override
public void doDynamicMethods()

@Override
public void setApplication(GrailsApplication application)