org.codehaus.groovy.grails.plugins

Class AbstractGrailsPlugin

java.lang.Object

groovy.lang.GroovyObjectSupport

org.codehaus.groovy.grails.plugins.AbstractGrailsPlugin

All Implemented Interfaces:

groovy.lang.GroovyObject, java.lang.Comparable, GrailsPlugin, org.codehaus.groovy.grails.plugins.GrailsPluginInfo, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

DefaultGrailsPlugin

public abstract class AbstractGrailsPlugin
extends groovy.lang.GroovyObjectSupport
implements GrailsPlugin

Abstract implementation that provides some default behaviours

Field Summary

Fields

Modifier and Type	Field and Description
protected GrailsApplication	application
protected org.springframework.context.ApplicationContext	applicationContext
protected java.util.Map<java.lang.String,java.lang.Object>	dependencies
protected java.lang.String[]	dependencyNames
protected java.lang.String[]	evictionList
protected boolean	isBase
protected GrailsPluginManager	manager
protected java.lang.Class<?>	pluginClass
protected java.lang.String	version

Fields inherited from interface org.codehaus.groovy.grails.plugins.GrailsPlugin

ARTEFACTS, DEPENDS_ON, DO_WITH_APPLICATION_CONTEXT, DO_WITH_DYNAMIC_METHODS, DO_WITH_SPRING, DO_WITH_WEB_DESCRIPTOR, ENVIRONMENTS, EVENT_ON_CHANGE, EVENT_ON_CONFIG_CHANGE, EVENT_ON_SHUTDOWN, EVICT, OBSERVE, ON_CHANGE, ON_CONFIG_CHANGE, ON_SHUTDOWN, PLUGIN_EXCLUDES, PLUGIN_LOAD_AFTER_NAMES, PLUGIN_LOAD_BEFORE_NAMES, PLUGINS_PATH, PROVIDED_ARTEFACTS, SCOPES, STATUS, STATUS_DISABLED, STATUS_ENABLED, TYPE_FILTERS, WATCHED_RESOURCES

Fields inherited from interface org.codehaus.groovy.grails.plugins.GrailsPluginInfo

NAME, TRAILING_NAME, VERSION

Constructor Summary

Constructors

Constructor and Description
AbstractGrailsPlugin(java.lang.Class<?> pluginClass, GrailsApplication application)

Method Summary

Modifier and Type	Method and Description
boolean	checkForChanges() When called this method checks for any changes to the plug-ins watched resources and reloads appropriately
int	compareTo(java.lang.Object o)
void	doWithWebDescriptor(org.w3c.dom.Element webXml) Handles processing of web.xml.
boolean	equals(java.lang.Object o)
java.lang.String[]	getDependencyNames()
java.lang.String	getDependentVersion(java.lang.String name) The version of the specified dependency
java.lang.String[]	getEvictionNames()
java.lang.String	getFileSystemName() Returns the name of the plugin as represented in the file system including the version.
java.lang.String	getFileSystemShortName() Returns the name of the plugin as represented on the file system without the version.
java.lang.String[]	getLoadAfterNames() Retrieves the names of plugins that this plugin should be loaded after.
java.lang.String[]	getLoadBeforeNames() Retrieves the names of plugins that this plugin should be loaded before.
GrailsPluginManager	getManager() Retrieves the plugin manager if known, otherwise returns null
java.lang.String	getName()
java.lang.Class<?>	getPluginClass() Returns the underlying class that represents this plugin
java.lang.String	getPluginPath() Returns the path of the plug-in
java.lang.String	getVersion()
java.util.List<org.codehaus.groovy.grails.plugins.support.WatchPattern>	getWatchedResourcePatterns() Resources that this plugin watches
int	hashCode()
boolean	hasInterestInChange(java.lang.String path) Whether the plugin is interested in a particular change
boolean	isBasePlugin() Returns whether this plugin is loaded from the current plugin.
void	refresh() Refreshes this Grails plugin reloading any watched resources as necessary
void	setApplication(GrailsApplication application)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setBasePlugin(boolean isBase) Sets whether this plugin is the base plugin
void	setManager(GrailsPluginManager manager) Sets the plugin manager for this plugin

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.groovy.grails.plugins.GrailsPlugin

addExclude, addExclude, doArtefactConfiguration, doc, doWithApplicationContext, doWithDynamicMethods, doWithRuntimeConfiguration, getInstance, getObservedPluginNames, getPluginExcludes, getProvidedArtefacts, getTypeFilters, isEnabled, notifyOfEvent, notifyOfEvent, setDescriptor, supportsCurrentScopeAndEnvironment, supportsEnvironment, supportsScope

Methods inherited from interface org.codehaus.groovy.grails.plugins.GrailsPluginInfo

getDescriptor, getFullName, getPluginDir, getProperties

Field Detail

application

protected GrailsApplication application

isBase

protected boolean isBase

version

protected java.lang.String version

dependencies

protected java.util.Map<java.lang.String,java.lang.Object> dependencies

dependencyNames

protected java.lang.String[] dependencyNames

pluginClass

protected java.lang.Class<?> pluginClass

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

manager

protected GrailsPluginManager manager

evictionList

protected java.lang.String[] evictionList

Constructor Detail

AbstractGrailsPlugin

public AbstractGrailsPlugin(java.lang.Class<?> pluginClass,
                            GrailsApplication application)

Method Detail

refresh

public void refresh()

Description copied from interface: GrailsPlugin

Refreshes this Grails plugin reloading any watched resources as necessary

Specified by:

refresh in interface GrailsPlugin

getFileSystemName

public java.lang.String getFileSystemName()

Description copied from interface: GrailsPlugin

Returns the name of the plugin as represented in the file system including the version. For example TagLibGrailsPlugin would result in "tag-lib-0.1"

Specified by:

getFileSystemName in interface GrailsPlugin

Returns:

The file system representation of the plugin name

getFileSystemShortName

public java.lang.String getFileSystemShortName()

Description copied from interface: GrailsPlugin

Returns the name of the plugin as represented on the file system without the version. For example TagLibGrailsPlugin would result in "tag-lib"

Specified by:

getFileSystemShortName in interface GrailsPlugin

Returns:

The file system name

getPluginClass

public java.lang.Class<?> getPluginClass()

Description copied from interface: GrailsPlugin

Returns the underlying class that represents this plugin

Specified by:

getPluginClass in interface GrailsPlugin

Returns:

The plugin class

isBasePlugin

public boolean isBasePlugin()

Description copied from interface: GrailsPlugin

Returns whether this plugin is loaded from the current plugin. In other words when you execute grails run-app from a plugin project the plugin project's *GrailsPlugin.groovy file represents the base plugin and this method will return true for this plugin

Specified by:

isBasePlugin in interface GrailsPlugin

Returns:

true if it is the base plugin

setBasePlugin

public void setBasePlugin(boolean isBase)

Description copied from interface: GrailsPlugin

Sets whether this plugin is the base plugin

Specified by:

setBasePlugin in interface GrailsPlugin

Parameters:

isBase - True if is

See Also:

GrailsPlugin.isBasePlugin()

getWatchedResourcePatterns

public java.util.List<org.codehaus.groovy.grails.plugins.support.WatchPattern> getWatchedResourcePatterns()

Description copied from interface: GrailsPlugin

Resources that this plugin watches

Specified by:

getWatchedResourcePatterns in interface GrailsPlugin

Returns:

The watch resource patterns

hasInterestInChange

public boolean hasInterestInChange(java.lang.String path)

Description copied from interface: GrailsPlugin

Whether the plugin is interested in a particular change

Specified by:

hasInterestInChange in interface GrailsPlugin

Parameters:

path - The path to the resource that changed

Returns:

true if it is

checkForChanges

public boolean checkForChanges()

Description copied from interface: GrailsPlugin

When called this method checks for any changes to the plug-ins watched resources and reloads appropriately

Specified by:

checkForChanges in interface GrailsPlugin

Returns:

Returns true when the plug-in itself changes in some way, as oppose to plug-in resources

doWithWebDescriptor

public void doWithWebDescriptor(org.w3c.dom.Element webXml)

Description copied from interface: GrailsPlugin

Handles processing of web.xml. The method is passed a GPathResult which is parsed by groovy.util.XmlSlurper. A plug-in can then manipulate the in-memory XML however it chooses Once all plug-ins have been processed the web.xml is then written to disk based on its in-memory form

Specified by:

doWithWebDescriptor in interface GrailsPlugin

Parameters:

webXml - The GPathResult representing web.xml

getDependencyNames

public java.lang.String[] getDependencyNames()

Specified by:

getDependencyNames in interface GrailsPlugin

Returns:

The names of the plugins this plugin is dependant on

getDependentVersion

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

Description copied from interface: GrailsPlugin

The version of the specified dependency

Specified by:

getDependentVersion in interface GrailsPlugin

Parameters:

name - the name of the dependency

Returns:

The version

getName

public java.lang.String getName()

Specified by:

getName in interface org.codehaus.groovy.grails.plugins.GrailsPluginInfo

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface org.codehaus.groovy.grails.plugins.GrailsPluginInfo

getPluginPath

public java.lang.String getPluginPath()

Description copied from interface: GrailsPlugin

Returns the path of the plug-in

Specified by:

getPluginPath in interface GrailsPlugin

Returns:

A String that makes up the path to the plug-in in the format /plugins/PLUGIN_NAME-PLUGIN_VERSION

getManager

public GrailsPluginManager getManager()

Description copied from interface: GrailsPlugin

Retrieves the plugin manager if known, otherwise returns null

Specified by:

getManager in interface GrailsPlugin

Returns:

The PluginManager or null

getLoadAfterNames

public java.lang.String[] getLoadAfterNames()

Description copied from interface: GrailsPlugin

Retrieves the names of plugins that this plugin should be loaded after. This differs from dependencies in that if that plugin doesn't exist this plugin will still be loaded. It is a way of enforcing plugins are loaded before, but not necessarily needed

Specified by:

getLoadAfterNames in interface GrailsPlugin

Returns:

The names of the plugins that this plugin should be loaded after

getLoadBeforeNames

public java.lang.String[] getLoadBeforeNames()

Description copied from interface: GrailsPlugin

Retrieves the names of plugins that this plugin should be loaded before. As with getLoadAfterNames() it is not a requirement that the specified plugins exist

Specified by:

getLoadBeforeNames in interface GrailsPlugin

Returns:

The names of the plugins that this plugin should load before

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

setManager

public void setManager(GrailsPluginManager manager)

Description copied from interface: GrailsPlugin

Sets the plugin manager for this plugin

Specified by:

setManager in interface GrailsPlugin

Parameters:

manager - A GrailsPluginManager instance

setApplication

public void setApplication(GrailsApplication application)

Specified by:

setApplication in interface GrailsPlugin

getEvictionNames

public java.lang.String[] getEvictionNames()

Specified by:

getEvictionNames in interface GrailsPlugin

Returns:

The names of the plugins this plugin should evict onload

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable