DefaultGrailsPlugin (Grace Framework

org.grails.plugins.DefaultGrailsPlugin

All Implemented Interfaces and Traits:

ParentApplicationContextAware
```
@SuppressWarnings("rawtypes")
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.
Authors:
Graeme Rocher
Since:
0.4

Field Summary

Fields
Modifiers	Name	Description
`protected static org.apache.commons.logging.Log`	`logger`
`protected BeanWrapper`	`pluginBean`

Inherited fields
Fields inherited from class	Fields
`class AbstractGrailsPlugin`	`PLUGIN_GROOVY, PLUGIN_GROOVY_PATH, PLUGIN_YML, PLUGIN_YML_PATH, applicationContext, config, dependencies, dependencyNames, evictionList, grailsApplication, isBase, manager, pluginClass, propertySource, version`

Constructor Summary

Constructors
Constructor and description
`DefaultGrailsPlugin(Class<?> pluginClass, Resource resource, GrailsApplication application)`
`DefaultGrailsPlugin(Class<?> pluginClass, GrailsApplication application)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addExclude(Environment env)`
	`public BeanBuilder`	`beans(Closure closure)`
	`public Object`	`call(Object arguments)`
	`public void`	`doArtefactConfiguration()`
	`public void`	`doWithApplicationContext(ApplicationContext ctx)`
	`public void`	`doWithDynamicMethods(ApplicationContext ctx)`
	`public void`	`doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)`
	`public void`	`doc(String text)` deprecated: Dynamic document generation no longer supported
	`public String[]`	`getDependencyNames()`
	`public String`	`getDependentVersion(String name)`
	`public Resource`	`getDescriptor()`
	`public String`	`getFullName()`
	`public GroovyObject`	`getInstance()`
	`public String[]`	`getLoadAfterNames()`
	`public String[]`	`getLoadBeforeNames()`
	`public org.apache.commons.logging.Log`	`getLog()`
	`public String`	`getName()`
	`public String[]`	`getObservedPluginNames()`
	`public ApplicationContext`	`getParentCtx()`
	`public GrailsPlugin`	`getPlugin()`
	`public Resource`	`getPluginDir()`
	`public List<String>`	`getPluginExcludes()`
	`public Map<String, Object>`	`getProperties()`
	`public Class<?>[]`	`getProvidedArtefacts()`
	`public PathMatchingResourcePatternResolver`	`getResolver()` Returns: the resolver
	`public List<WatchPattern>`	`getWatchedResourcePatterns()`
	`public Resource[]`	`getWatchedResources()` Returns: the watchedResources
	`public boolean`	`hasInterestInChange(String path)`
	`public boolean`	`isEnabled(String[] activeProfiles)`
	`public boolean`	`isEnabled()`
	`public void`	`notifyOfEvent(Map<String, Object> event)`
	`public Map<String, Object>`	`notifyOfEvent(int eventKind, Object source)`
	`public void`	`refresh()`
	`public void`	`setApplicationContext(ApplicationContext applicationContext)`
	`public void`	`setDescriptor(Resource descriptor)`
	`public void`	`setManager(GrailsPluginManager manager)`
	`public void`	`setParentApplicationContext(ApplicationContext parent)`
	`public void`	`setWatchedResources(Resource[] watchedResources)`
	`public boolean`	`supportsCurrentScopeAndEnvironment()`
	`public boolean`	`supportsEnvironment(Environment environment)`
	`public String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractGrailsPlugin`	checkForChanges, compareTo, equals, getConfigurationResource, getDependencyNames, getDependentVersion, getEvictionNames, getFileSystemName, getFileSystemShortName, getLoadAfterNames, getLoadBeforeNames, getManager, getName, getOrder, getPluginClass, getPluginPath, getPluginPathCamelCase, getPropertySource, getVersion, getWatchedResourcePatterns, hasInterestInChange, hashCode, isBasePlugin, isEnabled, readPluginConfiguration, refresh, setApplication, setApplicationContext, setBasePlugin, setManager

- Field Detail
  - protected static final org.apache.commons.logging.Log logger
  - protected BeanWrapper pluginBean
- Constructor Detail
  - public DefaultGrailsPlugin(Class<?> pluginClass, Resource resource, GrailsApplication application)
  - public DefaultGrailsPlugin(Class<?> pluginClass, GrailsApplication application)
- Method Detail
  - public void addExclude(Environment env)
  - public BeanBuilder beans(Closure closure)
  - @Override
    public Object call(Object arguments)
  - public void doArtefactConfiguration()
  - public void doWithApplicationContext(ApplicationContext ctx)
  - public void doWithDynamicMethods(ApplicationContext ctx)
  - public void doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)
  - @Deprecated
    public void doc(String text)
    
    deprecated:
    Dynamic document generation no longer supported
    
    Parameters:
    text
  - @Override
    public String[] getDependencyNames()
  - @Override
    public String getDependentVersion(String name)
  - public Resource getDescriptor()
  - public String getFullName()
  - public GroovyObject getInstance()
  - @Override
    public String[] getLoadAfterNames()
  - @Override
    public String[] getLoadBeforeNames()
  - public org.apache.commons.logging.Log getLog()
  - @Override
    public String getName()
  - public String[] getObservedPluginNames()
  - public ApplicationContext getParentCtx()
  - public GrailsPlugin getPlugin()
  - public Resource getPluginDir()
  - public List<String> getPluginExcludes()
  - @SuppressWarnings("unchecked")
    public Map<String, Object> getProperties()
  - public Class<?>[] getProvidedArtefacts()
  - public PathMatchingResourcePatternResolver getResolver()
    
    Returns:
    the resolver
  - @Override
    public List<WatchPattern> getWatchedResourcePatterns()
  - public Resource[] getWatchedResources()
    
    Returns:
    the watchedResources
  - @Override
    public boolean hasInterestInChange(String path)
  - @Override
    public boolean isEnabled(String[] activeProfiles)
  - public boolean isEnabled()
  - public void notifyOfEvent(Map<String, Object> event)
  - public Map<String, Object> notifyOfEvent(int eventKind, Object source)
  - @Override
    public void refresh()
  - @Override
    public void setApplicationContext(ApplicationContext applicationContext)
  - public void setDescriptor(Resource descriptor)
  - @Override
    public void setManager(GrailsPluginManager manager)
  - public void setParentApplicationContext(ApplicationContext parent)
  - public void setWatchedResources(Resource[] watchedResources)
  - public boolean supportsCurrentScopeAndEnvironment()
  - public boolean supportsEnvironment(Environment environment)
  - @Override
    public String toString()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class DefaultGrailsPlugin

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final org.apache.commons.logging.Log logger

protected BeanWrapper pluginBean

Constructor Detail

public DefaultGrailsPlugin(Class<?> pluginClass, Resource resource, GrailsApplication application)

public DefaultGrailsPlugin(Class<?> pluginClass, GrailsApplication application)

Method Detail

public void addExclude(Environment env)

public BeanBuilder beans(Closure closure)

@Overridepublic Object call(Object arguments)

public void doArtefactConfiguration()

public void doWithApplicationContext(ApplicationContext ctx)

public void doWithDynamicMethods(ApplicationContext ctx)

public void doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)

@Deprecatedpublic void doc(String text)

@Overridepublic String[] getDependencyNames()

@Overridepublic String getDependentVersion(String name)

public Resource getDescriptor()

public String getFullName()

public GroovyObject getInstance()

@Overridepublic String[] getLoadAfterNames()

@Overridepublic String[] getLoadBeforeNames()

public org.apache.commons.logging.Log getLog()

@Overridepublic String getName()

public String[] getObservedPluginNames()

public ApplicationContext getParentCtx()

public GrailsPlugin getPlugin()

public Resource getPluginDir()

public List<String> getPluginExcludes()

@SuppressWarnings("unchecked")public Map<String, Object> getProperties()

public Class<?>[] getProvidedArtefacts()

public PathMatchingResourcePatternResolver getResolver()

@Overridepublic List<WatchPattern> getWatchedResourcePatterns()

public Resource[] getWatchedResources()

@Overridepublic boolean hasInterestInChange(String path)

@Overridepublic boolean isEnabled(String[] activeProfiles)

public boolean isEnabled()

public void notifyOfEvent(Map<String, Object> event)

public Map<String, Object> notifyOfEvent(int eventKind, Object source)

@Overridepublic void refresh()

@Overridepublic void setApplicationContext(ApplicationContext applicationContext)

public void setDescriptor(Resource descriptor)

@Overridepublic void setManager(GrailsPluginManager manager)

public void setParentApplicationContext(ApplicationContext parent)

public void setWatchedResources(Resource[] watchedResources)

public boolean supportsCurrentScopeAndEnvironment()

public boolean supportsEnvironment(Environment environment)

@Overridepublic String toString()

@Override
public Object call(Object arguments)

@Deprecated
public void doc(String text)

@Override
public String[] getDependencyNames()

@Override
public String getDependentVersion(String name)

@Override
public String[] getLoadAfterNames()

@Override
public String[] getLoadBeforeNames()

@Override
public String getName()

@SuppressWarnings("unchecked")
public Map<String, Object> getProperties()

@Override
public List<WatchPattern> getWatchedResourcePatterns()

@Override
public boolean hasInterestInChange(String path)

@Override
public boolean isEnabled(String[] activeProfiles)

@Override
public void refresh()

@Override
public void setApplicationContext(ApplicationContext applicationContext)

@Override
public void setManager(GrailsPluginManager manager)

@Override
public String toString()