GrailsPluginManager (Grails 2.5.5.BUILD-SNAPSHOT)

org.codehaus.groovy.grails.plugins.GrailsPluginManager

All Superinterfaces:

org.springframework.beans.factory.Aware

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

Field Summary

Fields
Modifiers	Name	Description
`java.lang.String`	`BEAN_NAME`

Methods Summary

Methods
Type	Name and description
`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()` Called on all plugins so that they can add new methods/properties/constructors etc.
`void`	`doPostProcessing(org.springframework.context.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(java.lang.String pluginName, RuntimeSpringConfiguration springConfig)` Executes the runtime configuration for a specific plugin AND all its dependencies
`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
`void`	`doWebDescriptor(java.io.File descriptor, java.io.Writer target)` @see #doWebDescriptor(Resource, Writer)
`GrailsPlugin[]`	`getAllPlugins()` Returns an array of all the loaded plug-ins
`GrailsPlugin[]`	`getFailedLoadPlugins()` @return An array of plugins that failed to load due to dependency resolution errors
`GrailsPlugin`	`getFailedPlugin(java.lang.String name)` Retrieves a plug-in that failed to load, or null if it doesn't exist
`GrailsPlugin`	`getGrailsPlugin(java.lang.String name)` Retrieves a name Grails plugin instance
`GrailsPlugin`	`getGrailsPlugin(java.lang.String name, java.lang.Object version)` Retrieves a plug-in for its name and version
`GrailsPlugin`	`getGrailsPluginForClassName(java.lang.String name)` Obtains a GrailsPlugin for the given classname
`GrailsPlugin`	`getPluginForClass(java.lang.Class<?> theClass)` Obtains the GrailsPlugin for the given class
`GrailsPlugin`	`getPluginForInstance(java.lang.Object instance)` Looks up the plugin that defined the given instance.
`java.util.Collection`	`getPluginObservers(GrailsPlugin plugin)` Retrieves a collection of plugins that are observing the specified plugin
`java.lang.String`	`getPluginPath(java.lang.String name)` Returns the pluginContextPath for the given plugin
`java.lang.String`	`getPluginPathForClass(java.lang.Class<? extends java.lang.Object> theClass)` Returns the plugin path for the given class
`java.lang.String`	`getPluginPathForInstance(java.lang.Object instance)` Returns the pluginContextPath for the given instance
`java.lang.String`	`getPluginViewsPathForClass(java.lang.Class<? extends java.lang.Object> theClass)` Returns the plugin views directory path for the given class
`java.lang.String`	`getPluginViewsPathForInstance(java.lang.Object instance)` Returns the plugin views directory for the given instance
`java.util.List<org.springframework.core.type.filter.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(java.lang.String name)` @param name The name of the plugin
`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`	`informOfClassChange(java.lang.Class<?> aClass)` Method for handling changes to a class and triggering on change events etc.
`void`	`informOfClassChange(java.io.File file, java.lang.Class cls)`
`void`	`informOfFileChange(java.io.File file)` Fire to inform the PluginManager that a particular file changes
`boolean`	`isInitialised()` @return the initialised
`boolean`	`isShutdown()` Indicates whether the manager has been shutdown or not
`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`	`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(java.lang.String pluginName)` Returns true if the given plugin supports the current BuildScope

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface org.springframework.context.ApplicationContextAware`	`org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext)`
`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
  - public java.lang.String BEAN_NAME
- Method Detail
  - 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.
  - public void doPostProcessing(org.springframework.context.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(java.lang.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 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
    Parameters:
    descriptor - The Resource of the descriptor
    target - The Writer to write the result to
  - 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:
    doWebDescriptor(Resource, Writer)
  - public GrailsPlugin[] getAllPlugins()
    
    Returns an array of all the loaded plug-ins
    Returns:
    An array of plug-ins
  - public GrailsPlugin[] getFailedLoadPlugins()
    
    Returns:
    An array of plugins that failed to load due to dependency resolution errors
  - public GrailsPlugin getFailedPlugin(java.lang.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(java.lang.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(java.lang.String name, java.lang.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(java.lang.String name)
    
    Obtains a GrailsPlugin for the given classname
    Parameters:
    name - The name of the plugin
    Returns:
    The instance
  - public GrailsPlugin getPluginForClass(java.lang.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(java.lang.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
  - @java.lang.SuppressWarnings("rawtypes") public java.util.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
  - public java.lang.String getPluginPath(java.lang.String name)
    
    Returns the pluginContextPath for the given plugin
    Parameters:
    name - The plugin name
    Returns:
    the context path
  - public java.lang.String getPluginPathForClass(java.lang.Class<? extends java.lang.Object> theClass)
    
    Returns the plugin path for the given class
    Parameters:
    theClass - The class
    Returns:
    The pluginContextPath
  - public java.lang.String getPluginPathForInstance(java.lang.Object instance)
    
    Returns the pluginContextPath for the given instance
    Parameters:
    instance - The instance
    Returns:
    The pluginContextPath
  - public java.lang.String getPluginViewsPathForClass(java.lang.Class<? extends java.lang.Object> theClass)
    
    Returns the plugin views directory path for the given class
    Parameters:
    theClass - The class
    Returns:
    The pluginContextPath
  - public java.lang.String getPluginViewsPathForInstance(java.lang.Object instance)
    
    Returns the plugin views directory for the given instance
    Parameters:
    instance - The instance
    Returns:
    The pluginContextPath
  - public java.util.List<org.springframework.core.type.filter.TypeFilter> getTypeFilters()
    
    Get all of the TypeFilter definitions defined by the plugins
    Returns:
    A list of TypeFilter definitions
  - public GrailsPlugin[] getUserPlugins()
    
    Gets plugin installed by the user and not provided by the framework
    Returns:
    A list of user plugins
  - public boolean hasGrailsPlugin(java.lang.String name)
    
    Parameters:
    name - The name of the plugin
    Returns:
    true if the the manager has a loaded plugin with the given name
  - @java.lang.SuppressWarnings("rawtypes") public void informObservers(java.lang.String pluginName, java.util.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
  - public void informOfClassChange(java.lang.Class<?> aClass)
    
    Method for handling changes to a class and triggering on change events etc.
    Parameters:
    aClass - The class
  - public void informOfClassChange(java.io.File file, @java.lang.SuppressWarnings("rawtypes") java.lang.Class cls)
  - public void informOfFileChange(java.io.File file)
    
    Fire to inform the PluginManager that a particular file changes
    Parameters:
    file - The file that changed
    Since:
    2.0
  - 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 refreshPlugin(java.lang.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 setApplication(GrailsApplication application)
    
    Sets the GrailsApplication used be this plugin manager
    Parameters:
    application - The GrailsApplication instance
  - public void setLoadCorePlugins(boolean shouldLoadCorePlugins)
    
    Set whether the core plugins should be loaded
    Parameters:
    shouldLoadCorePlugins - True if they should
  - public void shutdown()
    
    Shuts down the PluginManager
  - public boolean supportsCurrentBuildScope(java.lang.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

Summary:
Field
Method

| Detail:
Field
Method

Groovy Documentation

[Java] Interface GrailsPluginManager

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public java.lang.String BEAN_NAME

Method Detail

public void checkForChanges()

public void doArtefactConfiguration()

public void doDynamicMethods()

public void doPostProcessing(org.springframework.context.ApplicationContext applicationContext)

public void doRuntimeConfiguration(RuntimeSpringConfiguration springConfig)

public void doRuntimeConfiguration(java.lang.String pluginName, RuntimeSpringConfiguration springConfig)

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

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

public GrailsPlugin[] getAllPlugins()

public GrailsPlugin[] getFailedLoadPlugins()

public GrailsPlugin getFailedPlugin(java.lang.String name)

public GrailsPlugin getGrailsPlugin(java.lang.String name)

public GrailsPlugin getGrailsPlugin(java.lang.String name, java.lang.Object version)

public GrailsPlugin getGrailsPluginForClassName(java.lang.String name)

public GrailsPlugin getPluginForClass(java.lang.Class<?> theClass)

public GrailsPlugin getPluginForInstance(java.lang.Object instance)

@java.lang.SuppressWarnings("rawtypes") public java.util.Collection getPluginObservers(GrailsPlugin plugin)

public java.lang.String getPluginPath(java.lang.String name)

public java.lang.String getPluginPathForClass(java.lang.Class<? extends java.lang.Object> theClass)

public java.lang.String getPluginPathForInstance(java.lang.Object instance)

public java.lang.String getPluginViewsPathForClass(java.lang.Class<? extends java.lang.Object> theClass)

public java.lang.String getPluginViewsPathForInstance(java.lang.Object instance)

public java.util.List<org.springframework.core.type.filter.TypeFilter> getTypeFilters()

public GrailsPlugin[] getUserPlugins()

public boolean hasGrailsPlugin(java.lang.String name)

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

public void informOfClassChange(java.lang.Class<?> aClass)

public void informOfClassChange(java.io.File file, @java.lang.SuppressWarnings("rawtypes") java.lang.Class cls)

public void informOfFileChange(java.io.File file)

public boolean isInitialised()

public boolean isShutdown()

public void loadPlugins()

public void refreshPlugin(java.lang.String name)

public void registerProvidedArtefacts(GrailsApplication application)

public void setApplication(GrailsApplication application)

public void setLoadCorePlugins(boolean shouldLoadCorePlugins)

public void shutdown()

public boolean supportsCurrentBuildScope(java.lang.String pluginName)