DefaultGrailsPluginManager (Grails 2.5.6.BUILD-SNAPSHOT)

org.codehaus.groovy.grails.plugins.DefaultGrailsPluginManager

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 (
Authors:
Graeme Rocher
See Also:
BeanBuilder<p<p<p<p<p<p>>>>>>
Since:
0.4

Field Summary

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

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

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name 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()`
	`void`	`doWebDescriptor(org.springframework.core.io.Resource descriptor, java.io.Writer target)`
	`void`	`doWebDescriptor(java.io.File descriptor, java.io.Writer target)`
	`protected void`	`evictPlugin(GrailsPlugin evictor, java.lang.String evicteeName)`
	`java.util.Collection<GrailsPlugin>`	`getPluginObservers(GrailsPlugin plugin)`
	`GrailsPlugin[]`	`getUserPlugins()`
	`void`	`informObservers(java.lang.String pluginName, java.util.Map event)`
	`void`	`loadPlugins()`
	`void`	`refreshPlugin(java.lang.String name)`
	`void`	`reloadPlugin(GrailsPlugin plugin)`
	`protected java.util.Map<GrailsPlugin, java.util.List<GrailsPlugin>>`	`resolveLoadDependencies(java.util.List<GrailsPlugin> plugins)`
	`void`	`setApplication(GrailsApplication application)`
	`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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractGrailsPluginManager`	checkInitialised, doArtefactConfiguration, doDynamicMethods, 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, setApplication, setApplicationContext, setLoadCorePlugins, shutdown, supportsCurrentBuildScope
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected static final java.lang.Class<?>[] COMMON_CLASSES
- Constructor Detail
  - public DefaultGrailsPluginManager(java.lang.String resourcePath, GrailsApplication application)
  - public DefaultGrailsPluginManager(java.lang.String[] pluginResources, GrailsApplication application)
  - public DefaultGrailsPluginManager(java.lang.Class<?>[] plugins, GrailsApplication application)
  - public DefaultGrailsPluginManager(org.springframework.core.io.Resource[] pluginFiles, GrailsApplication application)
- Method Detail
  - protected boolean canRegisterPlugin(GrailsPlugin plugin)
  - @java.lang.Deprecated public 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)
  - @java.lang.Override public void doDynamicMethods()
  - public void doWebDescriptor(org.springframework.core.io.Resource descriptor, java.io.Writer target)
  - public void doWebDescriptor(java.io.File descriptor, java.io.Writer target)
  - protected void evictPlugin(GrailsPlugin evictor, java.lang.String evicteeName)
  - public java.util.Collection<GrailsPlugin> getPluginObservers(GrailsPlugin plugin)
  - public GrailsPlugin[] getUserPlugins()
  - @java.lang.SuppressWarnings("rawtypes") public void informObservers(java.lang.String pluginName, java.util.Map event)
  - public void loadPlugins()
  - public void refreshPlugin(java.lang.String name)
  - public void reloadPlugin(GrailsPlugin plugin)
  - protected java.util.Map<GrailsPlugin, java.util.List<GrailsPlugin>> resolveLoadDependencies(java.util.List<GrailsPlugin> plugins)
  - @java.lang.Override public void setApplication(GrailsApplication application)
  - @java.lang.Override public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
  - public void setParentApplicationContext(org.springframework.context.ApplicationContext parent)
  - protected java.util.List<GrailsPlugin> sortPlugins(java.util.List<GrailsPlugin> toSort)
  - @java.lang.Deprecated public void startPluginChangeScanner()
    
    deprecated:
    Will be removed in a future version of Grails
  - @java.lang.Deprecated public void stopPluginChangeScanner()
    
    deprecated:
    Will be removed in a future version of Grails

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class DefaultGrailsPluginManager

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

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

Constructor Detail

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

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

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

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

Method Detail

protected boolean canRegisterPlugin(GrailsPlugin plugin)

@java.lang.Deprecated public void checkForChanges()

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

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

@java.lang.Override public void doDynamicMethods()

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

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

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

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

public GrailsPlugin[] getUserPlugins()

@java.lang.SuppressWarnings("rawtypes") public void informObservers(java.lang.String pluginName, java.util.Map event)

public void loadPlugins()

public void refreshPlugin(java.lang.String name)

public void reloadPlugin(GrailsPlugin plugin)

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

@java.lang.Override public void setApplication(GrailsApplication application)

@java.lang.Override public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

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

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

@java.lang.Deprecated public void startPluginChangeScanner()

@java.lang.Deprecated public void stopPluginChangeScanner()