GrailsPlugin (Grails 6.2.1)

grails.plugins.GrailsPluginInfo

All Superinterfaces:

GrailsPluginInfo
```
@java.lang.SuppressWarnings("rawtypes")
public interface GrailsPlugin
extends org.springframework.context.ApplicationContextAware, java.lang.Comparable, GrailsPluginInfo
```
Plugin interface that adds Spring org.springframework.beans.factory.config.BeanDefinitions to a registry based on a GrailsApplication object. After all GrailsPlugin classes have been processed the org.springframework.beans.factory.config.BeanDefinitions in the registry are loaded in a Spring org.springframework.context.ApplicationContext that's the singular configuration unit of Grails applications.

It's up to implementation classes to determine where GrailsPlugin instances are loaded from.

Authors:
Steven Devijver
Graeme Rocher
Since:
0.2
See Also:
org.springframework.beans.factory.support.BeanDefinitionRegistry

Field Summary

Fields
Modifiers	Name	Description
`java.lang.String`	`ARTEFACTS`	Define the list of ArtefactHandlers supporting by the plugin
`java.lang.String`	`DEPENDS_ON`	Defines the name of the property that specifies which plugins this plugin depends on
`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
`java.lang.String`	`DO_WITH_DYNAMIC_METHODS`
`java.lang.String`	`DO_WITH_SPRING`	Defines the name of the property that defines the closure that will be invoked during runtime spring configuration
`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
`java.lang.String`	`ENVIRONMENTS`	The environments to which this plugin applies
`int`	`EVENT_ON_CHANGE`
`int`	`EVENT_ON_CONFIG_CHANGE`
`int`	`EVENT_ON_SHUTDOWN`
`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
`java.lang.String`	`OBSERVE`	The field that represents the plugin names that this plugin is observing for changes.
`java.lang.String`	`ON_CHANGE`	Defines the name of the property that defines the closure that will be invoked when a watched resource changes
`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
`java.lang.String`	`ON_SHUTDOWN`	Defines the name of the property that holds a closure to be invoked when shutdown is called
`java.lang.String`	`PLUGINS_PATH`	The prefix used in plug-ins paths
`java.lang.String`	`PLUGIN_EXCLUDES`	The field that represents the list of resources to exclude from plugin packaging
`java.lang.String`	`PLUGIN_LOAD_AFTER_NAMES`	The name of the property that provides a list of plugins this plugin should after before
`java.lang.String`	`PLUGIN_LOAD_BEFORE_NAMES`	The name of the property that provides a list of plugins this plugin should load before
`java.lang.String`	`PROFILES`	The profiles for which this plugin is active
`java.lang.String`	`PROVIDED_ARTEFACTS`	The name of the property that provides a list of shipped, but overridable artefacts
`java.lang.String`	`SCOPES`	The scopes to which this plugin applies
`java.lang.String`	`STATUS`	The status of the plugin.
`java.lang.String`	`STATUS_DISABLED`	When a plugin is "disabled" it will not be loaded
`java.lang.String`	`STATUS_ENABLED`	When a plugin is "enabled" it will be loaded as usual.
`java.lang.String`	`TYPE_FILTERS`	The field that represents the list of type filters a plugin provides
`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

Inherited fields
Fields inherited from class	Fields
`interface GrailsPluginInfo`	`NAME, TRAILING_NAME, VERSION`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addExclude(Environment env)` Makes the plugin excluded for a particular Environment
	`public void`	`doArtefactConfiguration()` Called prior to the initialisation of the GrailsApplication instance to allow the registration of additonal ArtefactHandlers
	`public void`	`doWithApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
	`public void`	`doWithDynamicMethods(org.springframework.context.ApplicationContext applicationContext)` Calls a "doWithDynamicMethods" closure that allows a plugin to register dynamic methods at runtime
	`public void`	`doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)` Executes the plugin code that performs runtime configuration as defined in the doWithSpring closure
	`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
	`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.
	`public java.lang.String`	`getFileSystemShortName()` Returns the name of the plugin as represented on the file system without the version.
	`public groovy.lang.GroovyObject`	`getInstance()` Retrieves the wrapped plugin instance for this plugin
	`public java.lang.String[]`	`getLoadAfterNames()` Retrieves the names of 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.
	`public GrailsPluginManager`	`getManager()` Retrieves the plugin manager if known, otherwise returns null
	`public java.lang.String[]`	`getObservedPluginNames()` Retrieve the plugin names that this plugin is observing for changes
	`public java.lang.Class<?>`	`getPluginClass()` Returns the underlying class that represents this plugin
	`public java.util.List<java.lang.String>`	`getPluginExcludes()` A list of resources that the plugin should exclude from the packaged distribution
	`public java.lang.String`	`getPluginPath()` Returns the path of the plug-in
	`public java.lang.String`	`getPluginPathCamelCase()` Returns the path of the plug-in using camel case
	`public org.springframework.core.env.PropertySource<?>`	`getPropertySource()`
	`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
	`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
	`public java.util.List<WatchPattern>`	`getWatchedResourcePatterns()` Resources that this plugin watches
	`public boolean`	`hasInterestInChange(java.lang.String path)` Whether the plugin is interested in a particular change
	`public boolean`	`isBasePlugin()` Returns whether this plugin is loaded from the current plugin.
	`public boolean`	`isEnabled()` Returns: Whether the plugin is enabled or not
	`public boolean`	`isEnabled(java.lang.String[] activeProfiles)` Check whether the plugin is enabled for the given profile
	`public void`	`notifyOfEvent(java.util.Map event)` Notifies this plugin of the specified Event calling the onChange listener
	`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
	`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
	`public void`	`setDescriptor(org.springframework.core.io.Resource descriptor)` Sets the plugin descriptor for this plugin
	`public void`	`setManager(GrailsPluginManager manager)` Sets the plugin manager for this plugin
	`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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface org.springframework.context.ApplicationContextAware`	`org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext)`
`interface java.lang.Comparable`	`java.lang.Comparable#compareTo(java.lang.Object)`
`interface GrailsPluginInfo`	`getDescriptor, getFullName, getName, getPluginDir, getProperties, getVersion`

- Field Detail
  - java.lang.String ARTEFACTS
    
    Define the list of ArtefactHandlers supporting by the plugin
  - java.lang.String DEPENDS_ON
    
    Defines the name of the property that specifies which plugins this plugin depends on
  - 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
  - java.lang.String DO_WITH_DYNAMIC_METHODS
  - java.lang.String DO_WITH_SPRING
    
    Defines the name of the property that defines the closure that will be invoked during runtime spring configuration
  - 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
  - java.lang.String ENVIRONMENTS
    
    The environments to which this plugin applies
  - int EVENT_ON_CHANGE
  - int EVENT_ON_CONFIG_CHANGE
  - int EVENT_ON_SHUTDOWN
  - 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
  - java.lang.String OBSERVE
    
    The field that represents the plugin names that this plugin is observing for changes.
  - java.lang.String ON_CHANGE
    
    Defines the name of the property that defines the closure that will be invoked when a watched resource changes
  - 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
  - java.lang.String ON_SHUTDOWN
    
    Defines the name of the property that holds a closure to be invoked when shutdown is called
  - java.lang.String PLUGINS_PATH
    
    The prefix used in plug-ins paths
  - java.lang.String PLUGIN_EXCLUDES
    
    The field that represents the list of resources to exclude from plugin packaging
  - java.lang.String PLUGIN_LOAD_AFTER_NAMES
    
    The name of the property that provides a list of plugins this plugin should after before
  - java.lang.String PLUGIN_LOAD_BEFORE_NAMES
    
    The name of the property that provides a list of plugins this plugin should load before
  - java.lang.String PROFILES
    
    The profiles for which this plugin is active
  - java.lang.String PROVIDED_ARTEFACTS
    
    The name of the property that provides a list of shipped, but overridable artefacts
  - java.lang.String SCOPES
    
    The scopes to which this plugin applies
  - java.lang.String STATUS
    
    The status of the plugin.
  - java.lang.String STATUS_DISABLED
    
    When a plugin is "disabled" it will not be loaded
  - java.lang.String STATUS_ENABLED
    
    When a plugin is "enabled" it will be loaded as usual.
  - java.lang.String TYPE_FILTERS
    
    The field that represents the list of type filters a plugin provides
  - 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(Environment env)
    
    Makes the plugin excluded for a particular Environment
    Parameters:
    env - The Environment
  - 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
  - @java.lang.Deprecated public void doc(java.lang.String text)
    
    Write some documentation to the DocumentationContext
    deprecated:
    Dynamic document generation no longer supported
    
    Parameters:
    text
  - 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.String getPluginPathCamelCase()
    
    Returns the path of the plug-in using camel case
    Returns:
    A String that makes up the path to the plug-in in the format /plugins/pluginName-PLUGIN_VERSION
  - public org.springframework.core.env.PropertySource<?> getPropertySource()
  - 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 boolean isEnabled(java.lang.String[] activeProfiles)
    
    Check whether the plugin is enabled for the given profile
    Parameters:
    activeProfiles
    Returns:
    True if it is
  - 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

Summary:
Field
Method

| Detail:
Field
Method

Groovy Documentation

[Java] Interface GrailsPlugin

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

java.lang.String ARTEFACTS

java.lang.String DEPENDS_ON

java.lang.String DO_WITH_APPLICATION_CONTEXT

java.lang.String DO_WITH_DYNAMIC_METHODS

java.lang.String DO_WITH_SPRING

java.lang.String DO_WITH_WEB_DESCRIPTOR

java.lang.String ENVIRONMENTS

int EVENT_ON_CHANGE

int EVENT_ON_CONFIG_CHANGE

int EVENT_ON_SHUTDOWN

java.lang.String EVICT

java.lang.String OBSERVE

java.lang.String ON_CHANGE

java.lang.String ON_CONFIG_CHANGE

java.lang.String ON_SHUTDOWN

java.lang.String PLUGINS_PATH

java.lang.String PLUGIN_EXCLUDES

java.lang.String PLUGIN_LOAD_AFTER_NAMES

java.lang.String PLUGIN_LOAD_BEFORE_NAMES

java.lang.String PROFILES

java.lang.String PROVIDED_ARTEFACTS

java.lang.String SCOPES

java.lang.String STATUS

java.lang.String STATUS_DISABLED

java.lang.String STATUS_ENABLED

java.lang.String TYPE_FILTERS

java.lang.String WATCHED_RESOURCES

Method Detail

public void addExclude(Environment env)

public void doArtefactConfiguration()

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

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

public void doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)

@java.lang.Deprecated public void doc(java.lang.String text)

public java.lang.String[] getDependencyNames()

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

public java.lang.String[] getEvictionNames()

public java.lang.String getFileSystemName()

public java.lang.String getFileSystemShortName()

public groovy.lang.GroovyObject getInstance()

public java.lang.String[] getLoadAfterNames()

public java.lang.String[] getLoadBeforeNames()

public GrailsPluginManager getManager()

public java.lang.String[] getObservedPluginNames()

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

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

public java.lang.String getPluginPath()

public java.lang.String getPluginPathCamelCase()

public org.springframework.core.env.PropertySource<?> getPropertySource()

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

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

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

public boolean hasInterestInChange(java.lang.String path)

public boolean isBasePlugin()

public boolean isEnabled()

public boolean isEnabled(java.lang.String[] activeProfiles)

public void notifyOfEvent(java.util.Map event)

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

public void refresh()

public void setApplication(GrailsApplication application)

public void setBasePlugin(boolean isBase)

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

public void setManager(GrailsPluginManager manager)

public boolean supportsCurrentScopeAndEnvironment()

public boolean supportsEnvironment(Environment environment)