Field Detail

• public boolean enabled

  Whether the plugin is enabled

Property Detail

• ConfigurableApplicationContext applicationContext

• final java.util.List<ArtefactHandler> artefacts

  List of ArtefactHandler instances provided by this plugin

• 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

• @java.lang.Override
  BeanRegistrar beanRegistrar()

  Sub classes should override to register beans with the Spring Framework org.springframework.beans.factory.BeanRegistry using a org.springframework.beans.factory.BeanRegistrar. This is the modern, Spring-native replacement for the doWithSpring() bean builder DSL.

  The returned registrar is applied before Spring Boot auto-configuration is processed, so beans registered here take precedence over Boot's @ConditionalOnMissingBean defaults.

  Returns:

  A org.springframework.beans.factory.BeanRegistrar that registers beans, or null if none (the default)

  Since:

  8.0

• void beans(groovy.lang.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.Override
  void doWithApplicationContext()

  Invokes once the ApplicationContext has been refreshed and after {#doWithDynamicMethods()} is invoked. Subclasses should override

• @java.lang.Override
  void doWithDynamicMethods()

  Invoked in a phase where plugins can add dynamic methods. Subclasses should override

• @java.lang.Deprecated(since: 8.0)
  @java.lang.Override
  groovy.lang.Closure doWithSpring()

  Sub classes should override to provide implementations

  deprecated:

  since 8.0 in favour of beanRegistrar(). The underlying bean builder DSL remains available but is no longer actively supported and will not receive fixes for new issues — you are strongly urged to migrate to beanRegistrar().

  Returns:

  A closure that defines beans to be executed by Spring

• void doWithSpring(BeanBuilder beans)

  Registers Spring beans directly against the supplied BeanBuilder. This is the statically-compilable alternative to doWithSpring(): instead of returning a closure whose delegate the container wires up, an implementation registers beans against the builder passed as an argument. Subclasses should override. A plugin should override either this method or doWithSpring(), but not both: the two forms are alternatives, and defining both causes the plugin to fail to load.

  Parameters:

  beans - The BeanBuilder to register beans against

• ConfigurableApplicationContext getApplicationContext()

  Returns:

  The ApplicationContext

• Config getConfig()

  Returns:

  The Config instance for this plugin

• GrailsPluginManager getManager()

  The GrailsPluginManager instance

• void onChange(java.util.Map<java.lang.String, java.lang.Object> event)

  Invoked when a object this plugin is watching changes

  Parameters:

  event - The event

• @java.lang.Override
  void onConfigChange(java.util.Map<java.lang.String, java.lang.Object> event)

  Invoked when the application configuration changes

  Parameters:

  event - The event

• @java.lang.Override
  void onShutdown(java.util.Map<java.lang.String, java.lang.Object> event)

  Invoked when the ApplicationContext is closed

  Parameters:

  event - The event

• @java.lang.Override
  void onStartup(java.util.Map<java.lang.String, java.lang.Object> event)

• @java.lang.Override
  void setApplicationContext(ApplicationContext applicationContext)