Field Detail

• public java.lang.String ARTEFACTS

  Define the list of ArtefactHandlers supporting by the plugin

• public java.lang.String DEPENDS_ON

  Defines the name of the property that specifies which plugins this plugin depends on

• public java.lang.String DO_WITH_APPLICATION_CONTEXT

  Defines the name of the property that defines a closure that will be invoked after intialisation and when the application context has been built

• public java.lang.String DO_WITH_DYNAMIC_METHODS

• public java.lang.String DO_WITH_SPRING

  Defines the name of the property that defines the closure that will be invoked during runtime spring configuration

• public java.lang.String DO_WITH_WEB_DESCRIPTOR

  Defines the name of the property that defines the closure that will be invoked when the web.xml is being generated

• public java.lang.String ENVIRONMENTS

  The environments to which this plugin applies

• public int EVENT_ON_CHANGE

• public int EVENT_ON_CONFIG_CHANGE

• public int EVENT_ON_SHUTDOWN

• public java.lang.String EVICT

  Defines the name of the property that specifies a List or plugins that this plugin evicts Eviction occurs when the PluginManager loads

• public java.lang.String OBSERVE

  The field that represents the plugin names that this plugin is observing for changes.

• public java.lang.String ON_CHANGE

  Defines the name of the property that defines the closure that will be invoked when a watched resource changes

• public java.lang.String ON_CONFIG_CHANGE

  Defines the name of the property that defines the closure that will be invoked when a the Grails configuration object changes

• public java.lang.String ON_SHUTDOWN

  Defines the name of the property that holds a closure to be invoked when shutdown is called

• public java.lang.String PLUGINS_PATH

  The prefix used in plug-ins paths

• public java.lang.String PLUGIN_EXCLUDES

  The field that represents the list of resources to exclude from plugin packaging

• public java.lang.String PLUGIN_LOAD_AFTER_NAMES

  The name of the property that provides a list of plugins this plugin should after before

• public java.lang.String PLUGIN_LOAD_BEFORE_NAMES

  The name of the property that provides a list of plugins this plugin should load before

• public java.lang.String PROVIDED_ARTEFACTS

  The name of the property that provides a list of shipped, but overridable artefacts

• public java.lang.String SCOPES

  The scopes to which this plugin applies

• public java.lang.String STATUS

  The status of the plugin.

• public java.lang.String STATUS_DISABLED

  When a plugin is "disabled" it will not be loaded

• public java.lang.String STATUS_ENABLED

  When a plugin is "enabled" it will be loaded as usual.

• public java.lang.String TYPE_FILTERS

  The field that represents the list of type filters a plugin provides

• public java.lang.String WATCHED_RESOURCES

  Defines the name of the property that specifies resources which this plugin monitors for changes in the format a Ant-style path

Method Detail

• public void addExclude(BuildScope buildScope)

  Makes the plugin excluded for a particular BuildScope

  Parameters:

  buildScope - The BuildScope

• public void addExclude(Environment env)

  Makes the plugin excluded for a particular Environment

  Parameters:

  env - The Environment

• @java.lang.Deprecated public boolean checkForChanges()

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

  deprecated:

  Plugins themselves no longer check for changes

  Returns:

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

• public void doArtefactConfiguration()

  Called prior to the initialisation of the GrailsApplication instance to allow the registration of additonal ArtefactHandlers

  See Also:

  ArtefactHandler

• public void doWithApplicationContext(org.springframework.context.ApplicationContext applicationContext)

  This method is called to allow the plugin to add org.springframework.beans.factory.config.BeanDefinitions to the org.springframework.beans.factory.support.BeanDefinitionRegistry.

  Parameters:

  applicationContext - The Spring ApplicationContext instance

• public void doWithDynamicMethods(org.springframework.context.ApplicationContext applicationContext)

  Calls a "doWithDynamicMethods" closure that allows a plugin to register dynamic methods at runtime

  Parameters:

  applicationContext - The Spring ApplicationContext instance

• public void doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)

  Executes the plugin code that performs runtime configuration as defined in the doWithSpring closure

  Parameters:

  springConfig - The RuntimeSpringConfiguration instance

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

  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

  Parameters:

  webXml - The GPathResult representing web.xml

• public void doc(java.lang.String text)

  Write some documentation to the DocumentationContext

• public java.lang.String[] getDependencyNames()

  Returns:

  The names of the plugins this plugin is dependant on

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

  The version of the specified dependency

  Parameters:

  name - the name of the dependency

  Returns:

  The version

• public java.lang.String[] getEvictionNames()

  Returns:

  The names of the plugins this plugin should evict onload

• public java.lang.String getFileSystemName()

  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"

  Returns:

  The file system representation of the plugin name

• public java.lang.String getFileSystemShortName()

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

  Returns:

  The file system name

• public groovy.lang.GroovyObject getInstance()

  Retrieves the wrapped plugin instance for this plugin

  Returns:

  The plugin instance

• public java.lang.String[] getLoadAfterNames()

  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

  Returns:

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

• public java.lang.String[] getLoadBeforeNames()

  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

  Returns:

  The names of the plugins that this plugin should load before

• public GrailsPluginManager getManager()

  Retrieves the plugin manager if known, otherwise returns null

  Returns:

  The PluginManager or null

• public java.lang.String[] getObservedPluginNames()

  Retrieve the plugin names that this plugin is observing for changes

  Returns:

  The names of the observed plugins

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

  Returns the underlying class that represents this plugin

  Returns:

  The plugin class

• public java.util.List<java.lang.String> getPluginExcludes()

  A list of resources that the plugin should exclude from the packaged distribution

  Returns:

  a List of resources

• public java.lang.String getPluginPath()

  Returns the path of the plug-in

  Returns:

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

• public java.lang.Class<?>[] getProvidedArtefacts()

  Retrieves an array of provided Artefacts that are pre-compiled additions to the GrailsApplication object but are overridable by the end-user

  Returns:

  A list of provided artefacts

• public java.util.Collection<? extends org.springframework.core.type.filter.TypeFilter> getTypeFilters()

  Plugin can provide a list of Spring TypeFilters so that annotated components can be scanned into the ApplicationContext

  Returns:

  A collection of TypeFilter instance

• public java.util.List<WatchPattern> getWatchedResourcePatterns()

  Resources that this plugin watches

  Returns:

  The watch resource patterns

• public boolean hasInterestInChange(java.lang.String path)

  Whether the plugin is interested in a particular change

  Parameters:

  path - The path to the resource that changed

  Returns:

  true if it is

• public boolean isBasePlugin()

  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

  Returns:

  true if it is the base plugin

• public boolean isEnabled()

  Returns:

  Whether the plugin is enabled or not

• public void notifyOfEvent(java.util.Map event)

  Notifies this plugin of the specified Event calling the onChange listener

  Parameters:

  event - The event to listen for

• public java.util.Map notifyOfEvent(int eventKind, java.lang.Object source)

  Notifies the plugin of a specific event for the given event id, which is one of ON_CHANGE, ON_CONFIG_CHANGE

  Parameters:

  eventKind - The event kind

  source - The source of the event

  Returns:

  a Map that represents the event

• public void refresh()

  Refreshes this Grails plugin reloading any watched resources as necessary

• public void setApplication(GrailsApplication application)

• public void setBasePlugin(boolean isBase)

  Sets whether this plugin is the base plugin

  Parameters:

  isBase - True if is

  See Also:

  isBasePlugin()

• public void setDescriptor(org.springframework.core.io.Resource descriptor)

  Sets the plugin descriptor for this plugin

  Parameters:

  descriptor - The descriptor

• public void setManager(GrailsPluginManager manager)

  Sets the plugin manager for this plugin

  Parameters:

  manager - A GrailsPluginManager instance

• public boolean supportsCurrentScopeAndEnvironment()

  Returns:

  true if the current plugin supports the current BuildScope and Environment

• public boolean supportsEnvironment(Environment environment)

  Returns whether this plugin supports the given environment name

  Parameters:

  environment - The environment name

  Returns:

  true if it does

• public boolean supportsScope(BuildScope buildScope)

  Return whether this plugin supports the given PluginScope

  Parameters:

  buildScope - The PluginScope

  Returns:

  true if it does