Plugin (Grails 4.1.0.M1)

grails.plugins.Plugin

All Implemented Interfaces and Traits:

ApplicationContextAware, GrailsApplicationAware, GrailsApplicationLifeCycle, PluginManagerAware
```
@groovy.transform.CompileStaticCompileStatic
abstract class Plugin
extends java.lang.Object
```
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`
`private java.util.List`	`artefacts` List of ArtefactHandler instances provided by this plugin
`private boolean`	`enabled` Whether the plugin is enabled
`private Environment`	`environment` The current Grails Environment
`private GrailsApplication`	`grailsApplication` The GrailsApplication instance
`private GrailsPlugin`	`plugin` The GrailsPlugin definition for this plugin
`private 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 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 event)` Invoked when a object this plugin is watching changes Parameters: `event` - The event
	`void`	`onConfigChange(Map event)` Invoked when the application configuration changes Parameters: `event` - The event
	`void`	`onShutdown(Map event)` Invoked when the ApplicationContext is closed Parameters: `event` - The event
	`void`	`onStartup(Map event)`
	`void`	`setApplicationContext(ApplicationContext applicationContext)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - ConfigurableApplicationContext applicationContext
  - private final java.util.List artefacts
    
    List of ArtefactHandler instances provided by this plugin
  - private boolean enabled
    
    Whether the plugin is enabled
  - private Environment environment
    
    The current Grails Environment
  - private GrailsApplication grailsApplication
    
    The GrailsApplication instance
  - private GrailsPlugin plugin
    
    The GrailsPlugin definition for this plugin
  - private 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
  - @java.lang.OverrideOverride void doWithApplicationContext()
    
    Invokes once the ApplicationContext has been refreshed and after {#doWithDynamicMethods()} is invoked. Subclasses should override
  - @java.lang.OverrideOverride void doWithDynamicMethods()
    
    Invoked in a phase where plugins can add dynamic methods. Subclasses should override
  - @java.lang.OverrideOverride 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 event)
    
    Invoked when a object this plugin is watching changes
    Parameters:
    event - The event
  - @java.lang.OverrideOverride void onConfigChange(Map event)
    
    Invoked when the application configuration changes
    Parameters:
    event - The event
  - @java.lang.OverrideOverride void onShutdown(Map event)
    
    Invoked when the ApplicationContext is closed
    Parameters:
    event - The event
  - @java.lang.OverrideOverride void onStartup(Map event)
  - @java.lang.OverrideOverride 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

private final java.util.List artefacts

private boolean enabled

private Environment environment

private GrailsApplication grailsApplication

private GrailsPlugin plugin

private GrailsPluginManager pluginManager

Constructor Detail

Plugin()

Method Detail

void beans(Closure beanDefinitions)

@java.lang.OverrideOverride void doWithApplicationContext()

@java.lang.OverrideOverride void doWithDynamicMethods()

@java.lang.OverrideOverride Closure doWithSpring()

ConfigurableApplicationContext getApplicationContext()

Config getConfig()

GrailsPluginManager getManager()

void onChange(Map event)

@java.lang.OverrideOverride void onConfigChange(Map event)

@java.lang.OverrideOverride void onShutdown(Map event)

@java.lang.OverrideOverride void onStartup(Map event)

@java.lang.OverrideOverride void setApplicationContext(ApplicationContext applicationContext)