Plugin (Grace Framework

grails.plugins.Plugin

All Implemented Interfaces and Traits:

GrailsApplicationAware, GrailsApplicationLifeCycle, ApplicationContextAware, PluginManagerAware
```
@CompileStatic
abstract class Plugin
extends Object
implements GrailsApplicationAware, GrailsApplicationLifeCycle, ApplicationContextAware, PluginManagerAware
```
Super class for plugins to implement. Plugin implementations should define the various plugin hooks (doWithSpring, doWithApplicationContext, doWithDynamicMethods etc.)
Authors:
Graeme Rocher
Since:
3.0

Properties Summary

Properties
Type	Name and description
`ConfigurableApplicationContext`	`applicationContext`
`List<ArtefactHandler>`	`artefacts` List of ArtefactHandler instances provided by this plugin
`boolean`	`enabled` Whether the plugin is enabled
`Environment`	`environment` The current Grails Environment
`GrailsApplication`	`grailsApplication` The GrailsApplication instance
`GrailsPlugin`	`plugin` The GrailsPlugin definition for this plugin
`GrailsPluginManager`	`pluginManager` The GrailsPluginManager instance

Constructor Summary

Constructors
Constructor and description
`Plugin()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`beans(Closure beanDefinitions)` Allows a plugin to define beans at runtime.
	`void`	`doWithApplicationContext()` Invokes once the ApplicationContext has been refreshed and after {#doWithDynamicMethods()} is invoked.
	`void`	`doWithDynamicMethods()` Invoked in a phase where plugins can add dynamic methods.
	`Closure`	`doWithSpring()` Sub classes should override to provide implementations
	`ConfigurableApplicationContext`	`getApplicationContext()` Returns: The ApplicationContext
	`Config`	`getConfig()` Returns: The Config instance for this plugin
	`GrailsPluginManager`	`getManager()` The GrailsPluginManager instance
	`void`	`onChange(Map<String, Object> event)` Invoked when a object this plugin is watching changes
	`void`	`onConfigChange(Map<String, Object> event)` Invoked when the application configuration changes
	`void`	`onShutdown(Map<String, Object> event)` Invoked when the ApplicationContext is closed
	`void`	`onStartup(Map<String, Object> event)`
	`void`	`setApplicationContext(ApplicationContext applicationContext)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Property Detail
  - ConfigurableApplicationContext applicationContext
  - final List<ArtefactHandler> artefacts
    
    List of ArtefactHandler instances provided by this plugin
  - boolean enabled
    
    Whether the plugin is enabled
  - Environment environment
    
    The current Grails Environment
  - GrailsApplication grailsApplication
    
    The GrailsApplication instance
  - GrailsPlugin plugin
    
    The GrailsPlugin definition for this plugin
  - GrailsPluginManager pluginManager
    
    The GrailsPluginManager instance
- Constructor Detail
  - Plugin()
- Method Detail
  - void beans(Closure beanDefinitions)
    
    Allows a plugin to define beans at runtime. Used primarily for reloading in development mode
    Parameters:
    beanDefinitions - The bean definitions
    Returns:
    The BeanBuilder instance
  - @Override
    void doWithApplicationContext()
    
    Invokes once the ApplicationContext has been refreshed and after {#doWithDynamicMethods()} is invoked. Subclasses should override
  - @Override
    void doWithDynamicMethods()
    
    Invoked in a phase where plugins can add dynamic methods. Subclasses should override
  - @Override
    Closure doWithSpring()
    
    Sub classes should override to provide implementations
    Returns:
    A closure that defines beans to be executed by Spring
  - ConfigurableApplicationContext getApplicationContext()
    
    Returns:
    The ApplicationContext
  - Config getConfig()
    
    Returns:
    The Config instance for this plugin
  - GrailsPluginManager getManager()
    
    The GrailsPluginManager instance
  - void onChange(Map<String, Object> event)
    
    Invoked when a object this plugin is watching changes
    Parameters:
    event - The event
  - @Override
    void onConfigChange(Map<String, Object> event)
    
    Invoked when the application configuration changes
    Parameters:
    event - The event
  - @Override
    void onShutdown(Map<String, Object> event)
    
    Invoked when the ApplicationContext is closed
    Parameters:
    event - The event
  - @Override
    void onStartup(Map<String, Object> event)
  - @Override
    void setApplicationContext(ApplicationContext applicationContext)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class Plugin

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

ConfigurableApplicationContext applicationContext

final List<ArtefactHandler> artefacts

boolean enabled

Environment environment

GrailsApplication grailsApplication

GrailsPlugin plugin

GrailsPluginManager pluginManager

Constructor Detail

Plugin()

Method Detail

void beans(Closure beanDefinitions)

@Override
void doWithApplicationContext()

@Override
void doWithDynamicMethods()

@Override
Closure doWithSpring()

ConfigurableApplicationContext getApplicationContext()

Config getConfig()

GrailsPluginManager getManager()

void onChange(Map<String, Object> event)

@Override
void onConfigChange(Map<String, Object> event)

@Override
void onShutdown(Map<String, Object> event)

@Override
void onStartup(Map<String, Object> event)

@Override
void setApplicationContext(ApplicationContext applicationContext)

[Groovy] Class Plugin

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

ConfigurableApplicationContext applicationContext

final List<ArtefactHandler> artefacts

boolean enabled

Environment environment

GrailsApplication grailsApplication

GrailsPlugin plugin

GrailsPluginManager pluginManager

Constructor Detail

Plugin()

Method Detail

void beans(Closure beanDefinitions)

@Overridevoid doWithApplicationContext()

@Overridevoid doWithDynamicMethods()

@OverrideClosure doWithSpring()

ConfigurableApplicationContext getApplicationContext()

Config getConfig()

GrailsPluginManager getManager()

void onChange(Map<String, Object> event)

@Overridevoid onConfigChange(Map<String, Object> event)

@Overridevoid onShutdown(Map<String, Object> event)

@Overridevoid onStartup(Map<String, Object> event)

@Overridevoid setApplicationContext(ApplicationContext applicationContext)

@Override
void doWithApplicationContext()

@Override
void doWithDynamicMethods()

@Override
Closure doWithSpring()

@Override
void onConfigChange(Map<String, Object> event)

@Override
void onShutdown(Map<String, Object> event)

@Override
void onStartup(Map<String, Object> event)

@Override
void setApplicationContext(ApplicationContext applicationContext)