GrailsPluginManager (Grace Framework

```
public interface GrailsPluginManager
extends ApplicationContextAware, ApplicationStartupAware
```
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 Also:
BeanBuilder<p<p<p> Example: <pre>>>
Authors:
Graeme Rocher
Michael Yan
Since:
0.4

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addUserPlugin(Class<?> pluginClass)` Add User Plugin from Class
	`public void`	`checkForChanges()` Checks all the plugins to see whether they have any changes
	`public void`	`doArtefactConfiguration()` Called prior to the initialisation of the GrailsApplication object to allow registration of additional ArtefactHandler objects
	`public void`	`doDynamicMethods()` Called on all plugins so that they can add new methods/properties/constructors etc.
	`public void`	`doDynamicModules()` Called on all plugins so that they can register new modules.
	`public void`	`doPostProcessing(ApplicationContext applicationContext)` Performs post initialization configuration for each plug-in, passing the built application context
	`public void`	`doRuntimeConfiguration(RuntimeSpringConfiguration springConfig)` Executes the runtime configuration phase of plug-ins
	`public void`	`doRuntimeConfiguration(String pluginName, RuntimeSpringConfiguration springConfig)` Executes the runtime configuration for a specific plugin AND all its dependencies
	`public GrailsPlugin[]`	`getAllPlugins()` Returns an array of all the loaded plug-ins
	`public GrailsApplication`	`getApplication()` Get the GrailsApplication used be this plugin manager
	`public ApplicationStartup`	`getApplicationStartup()` Return the ApplicationStartup for this plugin manager.
`<D extends ModuleDescriptor<?>>`	`public List<D>`	`getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)` Get all enabled module descriptors that have a specific descriptor class.
	`public GrailsPlugin[]`	`getFailedLoadPlugins()` Returns: An array of plugins that failed to load due to dependency resolution errors
	`public GrailsPlugin`	`getFailedPlugin(String name)` Retrieves a plug-in that failed to load, or null if it doesn't exist
	`public GrailsPlugin`	`getGrailsPlugin(String name)` Retrieves a name Grails plugin instance
	`public GrailsPlugin`	`getGrailsPlugin(String name, Object version)` Retrieves a plug-in for its name and version
	`public GrailsPlugin`	`getGrailsPluginForClassName(String name)` Obtains a GrailsPlugin for the given classname
	`public Collection<ModuleDescriptor<?>>`	`getModuleDescriptors()` Gets all module descriptors of installed modules.
`<M>`	`public Collection<ModuleDescriptor<M>>`	`getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)` Gets all module descriptors of installed modules that match the given predicate.
	`public GrailsPlugin`	`getPluginForClass(Class<?> theClass)` Obtains the GrailsPlugin for the given class
	`public GrailsPlugin`	`getPluginForInstance(Object instance)` Looks up the plugin that defined the given instance.
	`public List<GrailsPlugin>`	`getPluginList()` Returns the list of all the plug-ins, included failed and unenabled
	`public Collection<GrailsPlugin>`	`getPluginObservers(GrailsPlugin plugin)` Retrieves a collection of plugins that are observing the specified plugin
	`public String`	`getPluginPath(String name)` Returns the pluginContextPath for the given plugin
	`public String`	`getPluginPath(String name, boolean forceCamelCase)` Returns the pluginContextPath for the given plugin and will force name to camel case instead of '-' lower case
	`public String`	`getPluginPathForClass(Class<?> theClass)` Returns the plugin path for the given class
	`public String`	`getPluginPathForInstance(Object instance)` Returns the pluginContextPath for the given instance
	`public String`	`getPluginViewsPathForClass(Class<?> theClass)` Returns the plugin views directory path for the given class
	`public String`	`getPluginViewsPathForInstance(Object instance)` Returns the plugin views directory for the given instance
	`public GrailsPlugin[]`	`getUserPlugins()` Gets plugin installed by the user and not provided by the framework
	`public boolean`	`hasGrailsPlugin(String name)` Parameters: `name` - The name of the plugin
	`public void`	`informObservers(String pluginName, Map<String, Object> event)` inform the specified plugins observers of the event specified by the passed Map instance
	`public void`	`informOfClassChange(Class<?> aClass)` Method for handling changes to a class and triggering on change events etc.
	`public void`	`informOfClassChange(File file, Class<?> cls)`
	`public void`	`informOfFileChange(File file)` Fire to inform the PluginManager that a particular file changes
	`public void`	`informPluginsOfConfigChange()` Inform of a change in configuration
	`public boolean`	`isInitialised()` Returns: the initialised
	`public boolean`	`isShutdown()` Indicates whether the manager has been shutdown or not
	`public void`	`loadPlugins()` Performs the initial load of plug-ins throwing an exception if any dependencies don't resolve
	`public void`	`onStartup(Map<String, Object> event)` Executes the Plugin.onStartup hook for all plugins
	`public void`	`refreshPlugin(String name)` Refreshes the specified plugin.
	`public 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.
	`public void`	`registerProvidedModules()` Registers provided ModuleDescriptor by DynamicGrailsPlugin.
	`public void`	`setApplication(GrailsApplication application)` Sets the GrailsApplication used be this plugin manager
	`public void`	`setApplicationStartup(ApplicationStartup applicationStartup)` Set the ApplicationStartup for this plugin manager.
	`public void`	`setLoadCorePlugins(boolean shouldLoadCorePlugins)` Set whether the core plugins should be loaded
	`public void`	`setPluginFilter(PluginFilter pluginFilter)` Sets the filter to use to filter for plugins
	`public void`	`shutdown()` Shuts down the PluginManager

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface ApplicationContextAware`	`setApplicationContext`
`interface ApplicationStartupAware`	`setApplicationStartup`

- Method Detail
  - public void addUserPlugin(Class<?> pluginClass)
    
    Add User Plugin from Class
    Parameters:
    pluginClass - the class of Plugin
    Since:
    2022.0.0
  - @Deprecated
    public void checkForChanges()
    
    Checks all the plugins to see whether they have any changes
  - public void doArtefactConfiguration()
    
    Called prior to the initialisation of the GrailsApplication object to allow registration of additional ArtefactHandler objects
    See Also:
    ArtefactHandler
  - public void doDynamicMethods()
    
    Called on all plugins so that they can add new methods/properties/constructors etc.
    Since:
    2023.0
  - public void doDynamicModules()
    
    Called on all plugins so that they can register new modules.
  - public void doPostProcessing(ApplicationContext applicationContext)
    
    Performs post initialization configuration for each plug-in, passing the built application context
    Parameters:
    applicationContext - The ApplicationContext instance
  - public void doRuntimeConfiguration(RuntimeSpringConfiguration springConfig)
    
    Executes the runtime configuration phase of plug-ins
    Parameters:
    springConfig - The RuntimeSpringConfiguration instance
  - public 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
  - public GrailsPlugin[] getAllPlugins()
    
    Returns an array of all the loaded plug-ins
    Returns:
    An array of plug-ins
  - public GrailsApplication getApplication()
    
    Get the GrailsApplication used be this plugin manager
  - public ApplicationStartup getApplicationStartup()
    
    Return the ApplicationStartup for this plugin manager.
    Since:
    2022.0.0
  - <D extends ModuleDescriptor<?>> public List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)
    
    Get all enabled module descriptors that have a specific descriptor class.
    Parameters:
    descriptorClazz - module descriptor class
    Returns:
    List of ModuleDescriptors that implement or extend the given class.
    Since:
    2022.0.0
  - public GrailsPlugin[] getFailedLoadPlugins()
    
    Returns:
    An array of plugins that failed to load due to dependency resolution errors
  - public 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
  - public 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
  - public 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
  - public GrailsPlugin getGrailsPluginForClassName(String name)
    
    Obtains a GrailsPlugin for the given classname
    Parameters:
    name - The name of the plugin
    Returns:
    The instance
  - public Collection<ModuleDescriptor<?>> getModuleDescriptors()
    
    Gets all module descriptors of installed modules.
    Since:
    2022.0.0
  - <M> public Collection<ModuleDescriptor<M>> getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
    
    Gets all module descriptors of installed modules that match the given predicate.
    Parameters:
    moduleDescriptorPredicate - describes which modules to match
    Returns:
    a collection of ModuleDescriptors that match the given predicate.
    Since:
    2022.0.0
  - public GrailsPlugin getPluginForClass(Class<?> theClass)
    
    Obtains the GrailsPlugin for the given class
    Parameters:
    theClass - The class
    Returns:
    The GrailsPlugin for the given class or null if not related to any plugin
  - public GrailsPlugin getPluginForInstance(Object instance)
    
    Looks up the plugin that defined the given instance. If no plugin defined the instance then null is returned.
    Parameters:
    instance - The instance
    Returns:
    The plugin that defined the instance or null
  - public List<GrailsPlugin> getPluginList()
    
    Returns the list of all the plug-ins, included failed and unenabled
    Returns:
    the list of plug-ins
    Since:
    2022.0.0
  - public Collection<GrailsPlugin> 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
  - public String getPluginPath(String name)
    
    Returns the pluginContextPath for the given plugin
    Parameters:
    name - The plugin name
    Returns:
    the context path
  - public String getPluginPath(String name, boolean forceCamelCase)
    
    Returns the pluginContextPath for the given plugin and will force name to camel case instead of '-' lower case my-plug-web would resolve to myPlugWeb if forceCamelCase is true.
    Parameters:
    name - The plugin name
    forceCamelCase - Force camel case for name
    Returns:
    the context path
  - public String getPluginPathForClass(Class<?> theClass)
    
    Returns the plugin path for the given class
    Parameters:
    theClass - The class
    Returns:
    The pluginContextPath
  - public String getPluginPathForInstance(Object instance)
    
    Returns the pluginContextPath for the given instance
    Parameters:
    instance - The instance
    Returns:
    The pluginContextPath
  - public String getPluginViewsPathForClass(Class<?> theClass)
    
    Returns the plugin views directory path for the given class
    Parameters:
    theClass - The class
    Returns:
    The pluginContextPath
  - public String getPluginViewsPathForInstance(Object instance)
    
    Returns the plugin views directory for the given instance
    Parameters:
    instance - The instance
    Returns:
    The pluginContextPath
  - public GrailsPlugin[] getUserPlugins()
    
    Gets plugin installed by the user and not provided by the framework
    Returns:
    A list of user plugins
  - public 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
  - public void informObservers(String pluginName, Map<String, Object> 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
  - public void informOfClassChange(Class<?> aClass)
    
    Method for handling changes to a class and triggering on change events etc.
    Parameters:
    aClass - The class
  - public void informOfClassChange(File file, Class<?> cls)
  - public void informOfFileChange(File file)
    
    Fire to inform the PluginManager that a particular file changes
    Parameters:
    file - The file that changed
    Since:
    2.0
  - public void informPluginsOfConfigChange()
    
    Inform of a change in configuration
  - public boolean isInitialised()
    
    Returns:
    the initialised
  - public boolean isShutdown()
    
    Indicates whether the manager has been shutdown or not
    Returns:
    True if it was shutdown
  - public void loadPlugins()
    
    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
  - public void onStartup(Map<String, Object> event)
    
    Executes the Plugin.onStartup hook for all plugins
    Parameters:
    event - the Event
  - public 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
  - public 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
  - public void registerProvidedModules()
    
    Registers provided ModuleDescriptor by DynamicGrailsPlugin.
    Since:
    2022.0.0
  - public void setApplication(GrailsApplication application)
    
    Sets the GrailsApplication used be this plugin manager
    Parameters:
    application - The GrailsApplication instance
  - public void setApplicationStartup(ApplicationStartup applicationStartup)
    
    Set the ApplicationStartup for this plugin manager.
    This allows the plugin manager to record metrics during startup.
    Parameters:
    applicationStartup - the new context event factory
    Since:
    2022.0.0
  - public void setLoadCorePlugins(boolean shouldLoadCorePlugins)
    
    Set whether the core plugins should be loaded
    Parameters:
    shouldLoadCorePlugins - True if they should
  - public void setPluginFilter(PluginFilter pluginFilter)
    
    Sets the filter to use to filter for plugins
    Parameters:
    pluginFilter - The plugin filter
  - public void shutdown()
    
    Shuts down the PluginManager

Summary:
Method

| Detail:
Method

[Java] Interface GrailsPluginManager

Methods Summary

Inherited Methods Summary

Method Detail

public void addUserPlugin(Class<?> pluginClass)

@Deprecatedpublic void checkForChanges()

public void doArtefactConfiguration()

public void doDynamicMethods()

public void doDynamicModules()

public void doPostProcessing(ApplicationContext applicationContext)

public void doRuntimeConfiguration(RuntimeSpringConfiguration springConfig)

public void doRuntimeConfiguration(String pluginName, RuntimeSpringConfiguration springConfig)

public GrailsPlugin[] getAllPlugins()

public GrailsApplication getApplication()

public ApplicationStartup getApplicationStartup()

<D extends ModuleDescriptor<?>> public List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)

public GrailsPlugin[] getFailedLoadPlugins()

public GrailsPlugin getFailedPlugin(String name)

public GrailsPlugin getGrailsPlugin(String name)

public GrailsPlugin getGrailsPlugin(String name, Object version)

public GrailsPlugin getGrailsPluginForClassName(String name)

public Collection<ModuleDescriptor<?>> getModuleDescriptors()

<M> public Collection<ModuleDescriptor<M>> getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)

public GrailsPlugin getPluginForClass(Class<?> theClass)

public GrailsPlugin getPluginForInstance(Object instance)

public List<GrailsPlugin> getPluginList()

public Collection<GrailsPlugin> getPluginObservers(GrailsPlugin plugin)

public String getPluginPath(String name)

public String getPluginPath(String name, boolean forceCamelCase)

public String getPluginPathForClass(Class<?> theClass)

public String getPluginPathForInstance(Object instance)

public String getPluginViewsPathForClass(Class<?> theClass)

public String getPluginViewsPathForInstance(Object instance)

public GrailsPlugin[] getUserPlugins()

public boolean hasGrailsPlugin(String name)

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

public void informOfClassChange(Class<?> aClass)

public void informOfClassChange(File file, Class<?> cls)

public void informOfFileChange(File file)

public void informPluginsOfConfigChange()

public boolean isInitialised()

public boolean isShutdown()

public void loadPlugins()

public void onStartup(Map<String, Object> event)

public void refreshPlugin(String name)

public void registerProvidedArtefacts(GrailsApplication application)

public void registerProvidedModules()

public void setApplication(GrailsApplication application)

public void setApplicationStartup(ApplicationStartup applicationStartup)

public void setLoadCorePlugins(boolean shouldLoadCorePlugins)

public void setPluginFilter(PluginFilter pluginFilter)

public void shutdown()

@Deprecated
public void checkForChanges()