DefaultGrailsPlugin

java.lang.Object
- GroovyObjectSupport
- - org.codehaus.groovy.grails.plugins.AbstractGrailsPlugin
  - - org.codehaus.groovy.grails.plugins.DefaultGrailsPlugin

All Implemented Interfaces:

java.lang.Comparable, GrailsPlugin, ParentApplicationContextAware

Direct Known Subclasses:

BinaryGrailsPlugin
```
public class DefaultGrailsPlugin
extends AbstractGrailsPlugin
implements ParentApplicationContextAware
```
Implementation of the GrailsPlugin interface that wraps a Groovy plugin class and provides the magic to invoke its various methods from Java.

Since:

0.4

Author:

Graeme Rocher

Field Summary
- 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, INFLUENCES, 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

Constructor Summary

Constructors
Constructor and Description
`DefaultGrailsPlugin(java.lang.Class<?> pluginClass, GrailsApplication application)`
`DefaultGrailsPlugin(java.lang.Class<?> pluginClass, Resource resource, GrailsApplication application)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addExclude(BuildScope buildScope)` Makes the plugin excluded for a particular BuildScope
`void`	`addExclude(Environment env)` Makes the plugin excluded for a particular BuildScope
`BeanBuilder`	`beans(Closure closure)`
`boolean`	`checkForChanges()` Deprecated.
`void`	`doArtefactConfiguration()` Called prior to the initialisation of the GrailsApplication instance to allow the registration of additonal ArtefactHandlers
`void`	`doc(java.lang.String text)` Write some documentation to the DocumentationContext
`void`	`doWithApplicationContext(ApplicationContext ctx)` This method is called to allow the plugin to add `org.springframework.beans.factory.config.BeanDefinition`s to the `org.springframework.beans.factory.support.BeanDefinitionRegistry`.
`void`	`doWithDynamicMethods(ApplicationContext ctx)` Calls a "doWithDynamicMethods" closure that allows a plugin to register dynamic methods at runtime
`void`	`doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)` Executes the plugin code that performs runtime configuration as defined in the doWithSpring closure
`void`	`doWithWebDescriptor(org.w3c.dom.Element webXml)` Handles processing of web.xml.
`java.lang.String[]`	`getDependencyNames()`
`java.lang.String`	`getDependentVersion(java.lang.String name)` The version of the specified dependency
`Resource`	`getDescriptor()`
`java.lang.String`	`getFullName()`
`GroovyObject`	`getInstance()` Retrieves the wrapped plugin instance for this plugin
`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.
`Log`	`getLog()`
`java.lang.String`	`getName()`
`java.lang.String[]`	`getObservedPluginNames()` Retrieve the plugin names that this plugin is observing for changes
`ApplicationContext`	`getParentCtx()`
`GrailsPlugin`	`getPlugin()`
`Resource`	`getPluginDir()`
`java.util.List<java.lang.String>`	`getPluginExcludes()` A list of resources that the plugin should exclude from the packaged distribution
`java.util.Map`	`getProperties()`
`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
`PathMatchingResourcePatternResolver`	`getResolver()`
`java.util.Collection<? extends TypeFilter>`	`getTypeFilters()` Plugin can provide a list of Spring TypeFilters so that annotated components can be scanned into the ApplicationContext
`java.util.List<WatchPattern>`	`getWatchedResourcePatterns()` Resources that this plugin watches
`Resource[]`	`getWatchedResources()`
`boolean`	`hasInterestInChange(java.lang.String path)` Whether the plugin is interested in a particular change
`boolean`	`isEnabled()`
`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
`void`	`notifyOfEvent(java.util.Map event)` Notifies this plugin of the specified Event calling the onChange listener
`void`	`refresh()` Refreshes this Grails plugin reloading any watched resources as necessary
`void`	`restartContainer()` Deprecated. Not needed any more due to the reload agent
`void`	`setDescriptor(Resource descriptor)` Sets the plugin descriptor for this plugin
`void`	`setParentApplicationContext(ApplicationContext parent)`
`void`	`setWatchedResources(Resource[] watchedResources)`
`boolean`	`supportsCurrentScopeAndEnvironment()`
`boolean`	`supportsEnvironment(Environment environment)` Returns whether this plugin supports the given environment name
`boolean`	`supportsScope(BuildScope buildScope)` Return whether this plugin supports the given PluginScope
`java.lang.String`	`toString()`

Methods inherited from class org.codehaus.groovy.grails.plugins.AbstractGrailsPlugin
compareTo, equals, getEvictionNames, getFileSystemName, getFileSystemShortName, getManager, getPluginClass, getPluginPath, getVersion, hashCode, isBasePlugin, setApplication, setApplicationContext, setBasePlugin, setManager

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DefaultGrailsPlugin
```
public DefaultGrailsPlugin(java.lang.Class<?> pluginClass,
                           Resource resource,
                           GrailsApplication application)
```
  - DefaultGrailsPlugin
```
public DefaultGrailsPlugin(java.lang.Class<?> pluginClass,
                           GrailsApplication application)
```
- Method Detail
  - getWatchedResourcePatterns
```
public java.util.List<WatchPattern> getWatchedResourcePatterns()
```
    Description copied from interface: GrailsPlugin
    
    Resources that this plugin watches
    
    Specified by:
    
    getWatchedResourcePatterns in interface GrailsPlugin
    
    Overrides:
    
    getWatchedResourcePatterns in class AbstractGrailsPlugin
    
    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
    
    Overrides:
    
    hasInterestInChange in class AbstractGrailsPlugin
    
    Parameters:
    
    path - The path to the resource that changed
    
    Returns:
    
    True if it is
  - 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
    
    Overrides:
    
    getLoadAfterNames in class AbstractGrailsPlugin
    
    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
    
    Overrides:
    
    getLoadBeforeNames in class AbstractGrailsPlugin
    
    Returns:
    
    The names of the plugins that this plugin should load before
  - getResolver
```
public PathMatchingResourcePatternResolver getResolver()
```
    Returns:
    
    the resolver
  - getParentCtx
```
public ApplicationContext getParentCtx()
```
  - beans
```
public BeanBuilder beans(Closure closure)
```
  - doWithApplicationContext
```
public void doWithApplicationContext(ApplicationContext ctx)
```
    Description copied from interface: GrailsPlugin
    
    This method is called to allow the plugin to add org.springframework.beans.factory.config.BeanDefinitions to the org.springframework.beans.factory.support.BeanDefinitionRegistry.
    
    Specified by:
    
    doWithApplicationContext in interface GrailsPlugin
    
    Parameters:
    
    ctx - The Spring ApplicationContext instance
  - doWithRuntimeConfiguration
```
public void doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)
```
    Description copied from interface: GrailsPlugin
    
    Executes the plugin code that performs runtime configuration as defined in the doWithSpring closure
    
    Specified by:
    
    doWithRuntimeConfiguration in interface GrailsPlugin
    
    Parameters:
    
    springConfig - The RuntimeSpringConfiguration instance
  - getName
```
public java.lang.String getName()
```
    Overrides:
    
    getName in class AbstractGrailsPlugin
  - addExclude
```
public void addExclude(BuildScope buildScope)
```
    Description copied from interface: GrailsPlugin
    
    Makes the plugin excluded for a particular BuildScope
    
    Specified by:
    
    addExclude in interface GrailsPlugin
    
    Parameters:
    
    buildScope - The BuildScope
  - addExclude
```
public void addExclude(Environment env)
```
    Description copied from interface: GrailsPlugin
    
    Makes the plugin excluded for a particular BuildScope
    
    Specified by:
    
    addExclude in interface GrailsPlugin
    
    Parameters:
    
    env - The BuildScope
  - supportsScope
```
public boolean supportsScope(BuildScope buildScope)
```
    Description copied from interface: GrailsPlugin
    
    Return whether this plugin supports the given PluginScope
    
    Specified by:
    
    supportsScope in interface GrailsPlugin
    
    Parameters:
    
    buildScope - The PluginScope
    
    Returns:
    
    True if it does
  - supportsEnvironment
```
public boolean supportsEnvironment(Environment environment)
```
    Description copied from interface: GrailsPlugin
    
    Returns whether this plugin supports the given environment name
    
    Specified by:
    
    supportsEnvironment in interface GrailsPlugin
    
    Parameters:
    
    environment - The environment name
    
    Returns:
    
    True if it does
  - supportsCurrentScopeAndEnvironment
```
public boolean supportsCurrentScopeAndEnvironment()
```
    Specified by:
    
    supportsCurrentScopeAndEnvironment in interface GrailsPlugin
    
    Returns:
    
    True if the current plugin supports the current BuildScope and Environment
  - doc
```
public void doc(java.lang.String text)
```
    Description copied from interface: GrailsPlugin
    
    Write some documentation to the DocumentationContext
    
    Specified by:
    
    doc in interface GrailsPlugin
  - getDependencyNames
```
public java.lang.String[] getDependencyNames()
```
    Specified by:
    
    getDependencyNames in interface GrailsPlugin
    
    Overrides:
    
    getDependencyNames in class AbstractGrailsPlugin
    
    Returns:
    
    The names of the plugins this plugin is dependant on
  - getWatchedResources
```
public Resource[] getWatchedResources()
```
    Returns:
    
    the watchedResources
  - 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
    
    Overrides:
    
    getDependentVersion in class AbstractGrailsPlugin
    
    Parameters:
    
    name - the name of the dependency
    
    Returns:
    
    The version
  - toString
```
public java.lang.String toString()
```
  - 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
    
    Overrides:
    
    doWithWebDescriptor in class AbstractGrailsPlugin
    
    Parameters:
    
    webXml - The GPathResult representing web.xml
  - checkForChanges
```
@Deprecated
public boolean checkForChanges()
```
    Deprecated.
    
    Monitors the plugin resources defined in the watchResources property for changes and fires onChange events by calling an onChange closure defined in the plugin (if it exists)
    
    Specified by:
    
    checkForChanges in interface GrailsPlugin
    
    Overrides:
    
    checkForChanges in class AbstractGrailsPlugin
    
    Returns:
    
    Returns true when the plug-in itself changes in some way, as oppose to plug-in resources
  - restartContainer
```
@Deprecated
public void restartContainer()
```
    Deprecated. Not needed any more due to the reload agent
    
    Restarts the container
  - setWatchedResources
```
public void setWatchedResources(Resource[] watchedResources)
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getLog
```
public Log getLog()
```
  - getPlugin
```
public GrailsPlugin getPlugin()
```
  - setParentApplicationContext
```
public void setParentApplicationContext(ApplicationContext parent)
```
    Specified by:
    
    setParentApplicationContext in interface ParentApplicationContextAware
  - 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
    
    Overrides:
    
    refresh in class AbstractGrailsPlugin
  - getInstance
```
public GroovyObject getInstance()
```
    Description copied from interface: GrailsPlugin
    
    Retrieves the wrapped plugin instance for this plugin
    
    Specified by:
    
    getInstance in interface GrailsPlugin
    
    Returns:
    
    The plugin instance
  - doWithDynamicMethods
```
public void doWithDynamicMethods(ApplicationContext ctx)
```
    Description copied from interface: GrailsPlugin
    
    Calls a "doWithDynamicMethods" closure that allows a plugin to register dynamic methods at runtime
    
    Specified by:
    
    doWithDynamicMethods in interface GrailsPlugin
    
    Parameters:
    
    ctx - The Spring ApplicationContext instance
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface GrailsPlugin
    
    Returns:
    
    Whether the plugin is enabled or not
  - getObservedPluginNames
```
public java.lang.String[] getObservedPluginNames()
```
    Description copied from interface: GrailsPlugin
    
    Retrieve the plugin names that this plugin is observing for changes
    
    Specified by:
    
    getObservedPluginNames in interface GrailsPlugin
    
    Returns:
    
    The names of the observed plugins
  - notifyOfEvent
```
public void notifyOfEvent(java.util.Map event)
```
    Description copied from interface: GrailsPlugin
    
    Notifies this plugin of the specified Event calling the onChange listener
    
    Specified by:
    
    notifyOfEvent in interface GrailsPlugin
    
    Parameters:
    
    event - The event to listen for
  - notifyOfEvent
```
public java.util.Map notifyOfEvent(int eventKind,
                                   java.lang.Object source)
```
    Description copied from interface: GrailsPlugin
    
    Notifies the plugin of a specific event for the given event id, which is one of ON_CHANGE, ON_CONFIG_CHANGE
    
    Specified by:
    
    notifyOfEvent in interface GrailsPlugin
    
    Parameters:
    
    eventKind - The event kind
    
    source - The source of the event
    
    Returns:
    
    a Map that represents the event
  - doArtefactConfiguration
```
public void doArtefactConfiguration()
```
    Description copied from interface: GrailsPlugin
    
    Called prior to the initialisation of the GrailsApplication instance to allow the registration of additonal ArtefactHandlers
    
    Specified by:
    
    doArtefactConfiguration in interface GrailsPlugin
    
    See Also:
    
    ArtefactHandler
  - getProvidedArtefacts
```
public java.lang.Class<?>[] getProvidedArtefacts()
```
    Description copied from interface: GrailsPlugin
    
    Retrieves an array of provided Artefacts that are pre-compiled additions to the GrailsApplication object but are overridable by the end-user
    
    Specified by:
    
    getProvidedArtefacts in interface GrailsPlugin
    
    Returns:
    
    A list of provided artefacts
  - getPluginExcludes
```
public java.util.List<java.lang.String> getPluginExcludes()
```
    Description copied from interface: GrailsPlugin
    
    A list of resources that the plugin should exclude from the packaged distribution
    
    Specified by:
    
    getPluginExcludes in interface GrailsPlugin
    
    Returns:
    
    a List of resources
  - getTypeFilters
```
public java.util.Collection<? extends TypeFilter> getTypeFilters()
```
    Description copied from interface: GrailsPlugin
    
    Plugin can provide a list of Spring TypeFilters so that annotated components can be scanned into the ApplicationContext
    
    Specified by:
    
    getTypeFilters in interface GrailsPlugin
    
    Returns:
    
    A collection of TypeFilter instance
  - getFullName
```
public java.lang.String getFullName()
```
  - getDescriptor
```
public Resource getDescriptor()
```
  - setDescriptor
```
public void setDescriptor(Resource descriptor)
```
    Description copied from interface: GrailsPlugin
    
    Sets the plugin descriptor for this plugin
    
    Specified by:
    
    setDescriptor in interface GrailsPlugin
    
    Parameters:
    
    descriptor - The descriptor
  - getPluginDir
```
public Resource getPluginDir()
```
  - getProperties
```
public java.util.Map getProperties()
```

Class DefaultGrailsPlugin

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.codehaus.groovy.grails.plugins.AbstractGrailsPlugin

Methods inherited from class java.lang.Object

Constructor Detail

DefaultGrailsPlugin

DefaultGrailsPlugin

Method Detail

getWatchedResourcePatterns

hasInterestInChange

getLoadAfterNames

getLoadBeforeNames

getResolver

getParentCtx

beans

doWithApplicationContext

doWithRuntimeConfiguration

getName

addExclude

addExclude

supportsScope

supportsEnvironment

supportsCurrentScopeAndEnvironment

doc

getDependencyNames

getWatchedResources

getDependentVersion

toString

doWithWebDescriptor

checkForChanges

restartContainer

setWatchedResources

getLog

getPlugin

setParentApplicationContext

refresh

getInstance

doWithDynamicMethods

isEnabled

getObservedPluginNames

notifyOfEvent

notifyOfEvent

doArtefactConfiguration

getProvidedArtefacts

getPluginExcludes

getTypeFilters

getFullName

getDescriptor

setDescriptor

getPluginDir

getProperties