Package org.grails.plugins

Class AbstractGrailsPluginManager

java.lang.Object

org.grails.plugins.AbstractGrailsPluginManager

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultGrailsPluginManager, MockGrailsPluginManager

public abstract class AbstractGrailsPluginManager
extends java.lang.Object
implements GrailsPluginManager

Abstract implementation of the GrailsPluginManager interface

Since:

0.4

Field Summary

Fields

Modifier and Type	Field	Description
protected GrailsApplication	application
protected org.springframework.context.ApplicationContext	applicationContext
protected java.util.Map<java.lang.String,GrailsPlugin>	classNameToPluginMap
static java.lang.String	CONFIG_FILE
protected java.util.Map<java.lang.String,GrailsPlugin>	failedPlugins
protected boolean	initialised
protected boolean	loadCorePlugins
protected java.lang.Class<?>[]	pluginClasses
protected java.util.List<GrailsPlugin>	pluginList
protected org.springframework.core.io.Resource[]	pluginResources
protected java.util.Map<java.lang.String,GrailsPlugin>	plugins
protected boolean	shutdown

Fields inherited from interface grails.plugins.GrailsPluginManager

BEAN_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractGrailsPluginManager(GrailsApplication application)

Method Summary

Modifier and Type	Method	Description
protected void	checkInitialised()
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 ctx)	Base implementation that will simply go through each plugin and call doWithApplicationContext on each.
void	doRuntimeConfiguration(java.lang.String pluginName, org.grails.spring.RuntimeSpringConfiguration springConfig)	Base implementation that will perform runtime configuration for the specified plugin name.
void	doRuntimeConfiguration(org.grails.spring.RuntimeSpringConfiguration springConfig)	Base implementation that simply goes through the list of plugins and calls doWithRuntimeConfiguration on each
GrailsPlugin[]	getAllPlugins()	Returns an array of all the loaded plug-ins
GrailsPlugin[]	getFailedLoadPlugins()
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.lang.String	getPluginPath(java.lang.String name)	Returns the pluginContextPath for the given plugin
java.lang.String	getPluginPath(java.lang.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.
java.lang.String	getPluginPathForClass(java.lang.Class<?> theClass)	Returns the plugin path for the given class
java.lang.String	getPluginPathForInstance(java.lang.Object instance)	Returns the pluginContextPath for the given instance
org.springframework.core.io.Resource[]	getPluginResources()
java.lang.String	getPluginViewsPathForClass(java.lang.Class<?> 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
boolean	hasGrailsPlugin(java.lang.String name)
void	informOfClassChange(java.io.File file, java.lang.Class cls)
void	informOfClassChange(java.lang.Class<?> aClass)	Method for handling changes to a class and triggering on change events etc.
void	informOfFileChange(java.io.File file)	Fire to inform the PluginManager that a particular file changes
void	informPluginsOfConfigChange()	Inform of a change in configuration
boolean	isInitialised()
protected boolean	isPluginDisabledForProfile(GrailsPlugin plugin)
boolean	isShutdown()	Indicates whether the manager has been shutdown or not
void	onStartup(java.util.Map<java.lang.String,java.lang.Object> event)	Executes the Plugin.onStartup(Map) hook for all plugins
void	registerProvidedArtefacts(GrailsApplication app)	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	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setLoadCorePlugins(boolean shouldLoadCorePlugins)	Set whether the core plugins should be loaded
void	setPluginFilter(PluginFilter pluginFilter)	Sets the filter to use to filter for plugins
void	shutdown()	Shuts down the PluginManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface grails.plugins.GrailsPluginManager

checkForChanges, getPluginObservers, getUserPlugins, informObservers, loadPlugins, refreshPlugin

Field Detail

CONFIG_FILE

public static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

pluginList

protected java.util.List<GrailsPlugin> pluginList

application

protected GrailsApplication application

pluginResources

protected org.springframework.core.io.Resource[] pluginResources

plugins

protected java.util.Map<java.lang.String,GrailsPlugin> plugins

classNameToPluginMap

protected java.util.Map<java.lang.String,GrailsPlugin> classNameToPluginMap

pluginClasses

protected java.lang.Class<?>[] pluginClasses

initialised

protected boolean initialised

shutdown

protected boolean shutdown

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

failedPlugins

protected java.util.Map<java.lang.String,GrailsPlugin> failedPlugins

loadCorePlugins

protected boolean loadCorePlugins

Constructor Detail

AbstractGrailsPluginManager

public AbstractGrailsPluginManager(GrailsApplication application)

Method Detail

getTypeFilters

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

Description copied from interface: GrailsPluginManager

Get all of the TypeFilter definitions defined by the plugins

Specified by:

getTypeFilters in interface GrailsPluginManager

Returns:

A list of TypeFilter definitions

getAllPlugins

public GrailsPlugin[] getAllPlugins()

Description copied from interface: GrailsPluginManager

Returns an array of all the loaded plug-ins

Specified by:

getAllPlugins in interface GrailsPluginManager

Returns:

An array of plug-ins

getFailedLoadPlugins

public GrailsPlugin[] getFailedLoadPlugins()

Specified by:

getFailedLoadPlugins in interface GrailsPluginManager

Returns:

An array of plugins that failed to load due to dependency resolution errors

isInitialised

public boolean isInitialised()

Specified by:

isInitialised in interface GrailsPluginManager

Returns:

the initialised

checkInitialised

protected void checkInitialised()

getFailedPlugin

public GrailsPlugin getFailedPlugin(java.lang.String name)

Description copied from interface: GrailsPluginManager

Retrieves a plug-in that failed to load, or null if it doesn't exist

Specified by:

getFailedPlugin in interface GrailsPluginManager

Parameters:

name - The name of the plugin

Returns:

A GrailsPlugin or null

doRuntimeConfiguration

public void doRuntimeConfiguration(org.grails.spring.RuntimeSpringConfiguration springConfig)

Base implementation that simply goes through the list of plugins and calls doWithRuntimeConfiguration on each

Specified by:

doRuntimeConfiguration in interface GrailsPluginManager

Parameters:

springConfig - The RuntimeSpringConfiguration instance

doRuntimeConfiguration

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

Base implementation that will perform runtime configuration for the specified plugin name.

Specified by:

doRuntimeConfiguration in interface GrailsPluginManager

Parameters:

pluginName - The name of he plugin

springConfig - The runtime spring config instance

doPostProcessing

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

Base implementation that will simply go through each plugin and call doWithApplicationContext on each.

Specified by:

doPostProcessing in interface GrailsPluginManager

Parameters:

ctx - The ApplicationContext instance

getPluginResources

public org.springframework.core.io.Resource[] getPluginResources()

getGrailsPlugin

public GrailsPlugin getGrailsPlugin(java.lang.String name)

Description copied from interface: GrailsPluginManager

Retrieves a name Grails plugin instance

Specified by:

getGrailsPlugin in interface GrailsPluginManager

Parameters:

name - The name of the plugin

Returns:

The GrailsPlugin instance or null if it doesn't exist

getGrailsPluginForClassName

public GrailsPlugin getGrailsPluginForClassName(java.lang.String name)

Description copied from interface: GrailsPluginManager

Obtains a GrailsPlugin for the given classname

Specified by:

getGrailsPluginForClassName in interface GrailsPluginManager

Parameters:

name - The name of the plugin

Returns:

The instance

getGrailsPlugin

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

Description copied from interface: GrailsPluginManager

Retrieves a plug-in for its name and version

Specified by:

getGrailsPlugin in interface GrailsPluginManager

Parameters:

name - The name of the plugin

version - The version of the plugin

Returns:

The GrailsPlugin instance or null if it doesn't exist

hasGrailsPlugin

public boolean hasGrailsPlugin(java.lang.String name)

Specified by:

hasGrailsPlugin in interface GrailsPluginManager

Parameters:

name - The name of the plugin

Returns:

true if the the manager has a loaded plugin with the given name

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

setApplicationContext

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

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

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

Parameters:

application - The GrailsApplication instance

registerProvidedArtefacts

public void registerProvidedArtefacts(GrailsApplication app)

Description copied from interface: GrailsPluginManager

Registers pre-compiled artefacts with the GrailsApplication instance, only overriding if the application doesn't already provide an artefact of the same name.

Specified by:

registerProvidedArtefacts in interface GrailsPluginManager

Parameters:

app - The GrailsApplication object

doArtefactConfiguration

public void doArtefactConfiguration()

Description copied from interface: GrailsPluginManager

Called prior to the initialisation of the GrailsApplication object to allow registration of additional ArtefactHandler objects

Specified by:

doArtefactConfiguration in interface GrailsPluginManager

See Also:

ArtefactHandler

isPluginDisabledForProfile

protected boolean isPluginDisabledForProfile(GrailsPlugin plugin)

onStartup

public void onStartup(java.util.Map<java.lang.String,java.lang.Object> event)

Description copied from interface: GrailsPluginManager

Executes the Plugin.onStartup(Map) hook for all plugins

Specified by:

onStartup in interface GrailsPluginManager

Parameters:

event - the Event

shutdown

public void shutdown()

Description copied from interface: GrailsPluginManager

Shuts down the PluginManager

Specified by:

shutdown in interface GrailsPluginManager

isShutdown

public boolean isShutdown()

Description copied from interface: GrailsPluginManager

Indicates whether the manager has been shutdown or not

Specified by:

isShutdown in interface GrailsPluginManager

Returns:

True if it was shutdown

setPluginFilter

public void setPluginFilter(PluginFilter pluginFilter)

Description copied from interface: GrailsPluginManager

Sets the filter to use to filter for plugins

Specified by:

setPluginFilter in interface GrailsPluginManager

Parameters:

pluginFilter - The plugin filter

setLoadCorePlugins

public void setLoadCorePlugins(boolean shouldLoadCorePlugins)

Description copied from interface: GrailsPluginManager

Set whether the core plugins should be loaded

Specified by:

setLoadCorePlugins in interface GrailsPluginManager

Parameters:

shouldLoadCorePlugins - True if they should

informOfClassChange

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

Description copied from interface: GrailsPluginManager

Method for handling changes to a class and triggering on change events etc.

Specified by:

informOfClassChange in interface GrailsPluginManager

Parameters:

aClass - The class

getPluginPath

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

Description copied from interface: GrailsPluginManager

Returns the pluginContextPath for the given plugin

Specified by:

getPluginPath in interface GrailsPluginManager

Parameters:

name - The plugin name

Returns:

the context path

getPluginPath

public java.lang.String getPluginPath(java.lang.String name,
                                      boolean forceCamelCase)

Description copied from interface: GrailsPluginManager

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.

Specified by:

getPluginPath in interface GrailsPluginManager

Parameters:

name - The plugin name

forceCamelCase - Force camel case for name

Returns:

the context path

getPluginPathForInstance

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

Description copied from interface: GrailsPluginManager

Returns the pluginContextPath for the given instance

Specified by:

getPluginPathForInstance in interface GrailsPluginManager

Parameters:

instance - The instance

Returns:

The pluginContextPath

getPluginForInstance

public GrailsPlugin getPluginForInstance(java.lang.Object instance)

Description copied from interface: GrailsPluginManager

Looks up the plugin that defined the given instance. If no plugin defined the instance then null is returned.

Specified by:

getPluginForInstance in interface GrailsPluginManager

Parameters:

instance - The instance

Returns:

The plugin that defined the instance or null

getPluginForClass

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

Description copied from interface: GrailsPluginManager

Obtains the GrailsPlugin for the given class

Specified by:

getPluginForClass in interface GrailsPluginManager

Parameters:

theClass - The class

Returns:

The GrailsPlugin for the given class or null if not related to any plugin

informPluginsOfConfigChange

public void informPluginsOfConfigChange()

Description copied from interface: GrailsPluginManager

Inform of a change in configuration

Specified by:

informPluginsOfConfigChange in interface GrailsPluginManager

informOfFileChange

public void informOfFileChange(java.io.File file)

Description copied from interface: GrailsPluginManager

Fire to inform the PluginManager that a particular file changes

Specified by:

informOfFileChange in interface GrailsPluginManager

Parameters:

file - The file that changed

informOfClassChange

public void informOfClassChange(java.io.File file,
                                java.lang.Class cls)

Specified by:

informOfClassChange in interface GrailsPluginManager

getPluginPathForClass

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

Description copied from interface: GrailsPluginManager

Returns the plugin path for the given class

Specified by:

getPluginPathForClass in interface GrailsPluginManager

Parameters:

theClass - The class

Returns:

The pluginContextPath

getPluginViewsPathForInstance

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

Description copied from interface: GrailsPluginManager

Returns the plugin views directory for the given instance

Specified by:

getPluginViewsPathForInstance in interface GrailsPluginManager

Parameters:

instance - The instance

Returns:

The pluginContextPath

getPluginViewsPathForClass

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

Description copied from interface: GrailsPluginManager

Returns the plugin views directory path for the given class

Specified by:

getPluginViewsPathForClass in interface GrailsPluginManager

Parameters:

theClass - The class

Returns:

The pluginContextPath