AbstractGrailsPluginManager (Grace Framework

org.grails.plugins.AbstractGrailsPluginManager

All Implemented Interfaces and Traits:

GrailsPluginManager
```
public abstract class AbstractGrailsPluginManager
extends Object
implements GrailsPluginManager
```
Abstract implementation of the GrailsPluginManager interface
Authors:
Graeme Rocher
Michael Yan
Since:
0.4

Field Summary

Fields
Modifiers	Name	Description
`static String`	`CONFIG_FILE`
`protected GrailsApplication`	`application`
`protected ApplicationContext`	`applicationContext`
`protected Map<String, GrailsPlugin>`	`classNameToPluginMap`
`protected Map<String, GrailsPlugin>`	`failedPlugins`
`protected boolean`	`initialised`
`protected boolean`	`loadCorePlugins`
`protected List<GrailsPlugin>`	`loadedPlugins`
`protected ModuleDescriptorFactory`	`moduleDescriptorFactory`
`protected Set<Class<?>>`	`pluginClasses`
`protected Resource[]`	`pluginResources`
`protected Map<String, GrailsPlugin>`	`plugins`
`protected boolean`	`shutdown`

Constructor Summary

Constructors
Constructor and description
`AbstractGrailsPluginManager(GrailsApplication application)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addUserPlugin(Class<?> pluginClass)` Add User Plugin from Class
	`protected void`	`checkInitialised()`
	`public Object`	`convert(NullSafeNavigator source)`
	`public void`	`doArtefactConfiguration()`
	`public void`	`doDynamicMethods()`
	`public void`	`doDynamicModules()`
	`public void`	`doPostProcessing(ApplicationContext ctx)` Base implementation that will simply go through each plugin and call doWithApplicationContext on each.
	`public void`	`doRuntimeConfiguration(RuntimeSpringConfiguration springConfig)` Base implementation that simply goes through the list of plugins and calls doWithRuntimeConfiguration on each
	`public void`	`doRuntimeConfiguration(String pluginName, RuntimeSpringConfiguration springConfig)` Base implementation that will perform runtime configuration for the specified plugin name.
	`public GrailsPlugin[]`	`getAllPlugins()`
	`public GrailsApplication`	`getApplication()`
	`public ApplicationStartup`	`getApplicationStartup()`
`<D extends ModuleDescriptor<?>>`	`public List<D>`	`getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)` Get all enabled module descriptors that have a specific descriptor class.
	`public GrailsPlugin[]`	`getFailedLoadPlugins()`
	`public GrailsPlugin`	`getFailedPlugin(String name)`
	`public GrailsPlugin`	`getGrailsPlugin(String name)`
	`public GrailsPlugin`	`getGrailsPlugin(String name, Object version)`
	`public GrailsPlugin`	`getGrailsPluginForClassName(String name)`
	`public Collection<ModuleDescriptor<?>>`	`getModuleDescriptors()` Gets all module descriptors of installed modules.
`<M>`	`public Collection<ModuleDescriptor<M>>`	`getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)`
	`public GrailsPlugin`	`getPluginForClass(Class<?> theClass)`
	`public GrailsPlugin`	`getPluginForInstance(Object instance)`
	`public String`	`getPluginPath(String name)`
	`public String`	`getPluginPath(String name, boolean forceCamelCase)`
	`public String`	`getPluginPathForClass(Class<?> theClass)`
	`public String`	`getPluginPathForInstance(Object instance)`
	`public Resource[]`	`getPluginResources()`
	`public String`	`getPluginViewsPathForClass(Class<?> theClass)`
	`public String`	`getPluginViewsPathForInstance(Object instance)`
	`public boolean`	`hasGrailsPlugin(String name)`
	`public void`	`informOfClassChange(Class<?> aClass)`
	`public void`	`informOfClassChange(File file, Class<?> cls)`
	`public void`	`informOfFileChange(File file)`
	`public void`	`informPluginsOfConfigChange()`
	`public boolean`	`isInitialised()` Returns: the initialised
	`protected boolean`	`isPluginDisabledForProfile(GrailsPlugin plugin)`
	`public boolean`	`isShutdown()`
	`public void`	`onStartup(Map<String, Object> event)`
	`public void`	`registerProvidedArtefacts(GrailsApplication app)`
	`public void`	`registerProvidedModules()`
	`public void`	`setApplication(GrailsApplication application)`
	`public void`	`setApplicationContext(ApplicationContext applicationContext)`
	`public void`	`setApplicationStartup(ApplicationStartup applicationStartup)`
	`public void`	`setLoadCorePlugins(boolean shouldLoadCorePlugins)`
	`public void`	`setPluginFilter(PluginFilter pluginFilter)`
	`public void`	`shutdown()`

Inherited Methods Summary

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

- Field Detail
  - public static final String CONFIG_FILE
  - protected GrailsApplication application
  - protected ApplicationContext applicationContext
  - protected Map<String, GrailsPlugin> classNameToPluginMap
  - protected Map<String, GrailsPlugin> failedPlugins
  - protected boolean initialised
  - protected boolean loadCorePlugins
  - protected List<GrailsPlugin> loadedPlugins
  - protected ModuleDescriptorFactory moduleDescriptorFactory
  - protected Set<Class<?>> pluginClasses
  - protected Resource[] pluginResources
  - protected Map<String, GrailsPlugin> plugins
  - protected boolean shutdown
- Constructor Detail
  - public AbstractGrailsPluginManager(GrailsApplication application)
- Method Detail
  - public void addUserPlugin(Class<?> pluginClass)
    
    Add User Plugin from Class
    Parameters:
    pluginClass - the class of Plugin
    Since:
    2022.0.0
  - protected void checkInitialised()
  - @Override
    public Object convert(NullSafeNavigator source)
  - public void doArtefactConfiguration()
  - public void doDynamicMethods()
  - public void doDynamicModules()
  - public void doPostProcessing(ApplicationContext ctx)
    
    Base implementation that will simply go through each plugin and call doWithApplicationContext on each.
  - public void doRuntimeConfiguration(RuntimeSpringConfiguration springConfig)
    
    Base implementation that simply goes through the list of plugins and calls doWithRuntimeConfiguration on each
    Parameters:
    springConfig - The RuntimeSpringConfiguration instance
  - public void doRuntimeConfiguration(String pluginName, RuntimeSpringConfiguration springConfig)
    
    Base implementation that will perform runtime configuration for the specified plugin name.
  - public GrailsPlugin[] getAllPlugins()
  - public GrailsApplication getApplication()
  - @Override
    public ApplicationStartup getApplicationStartup()
  - <D extends ModuleDescriptor<?>> @Override
    public List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)
    
    Get all enabled module descriptors that have a specific descriptor class.
    Parameters:
    descriptorClazz - module descriptor class
    Returns:
    List of ModuleDescriptors that implement or extend the given class.
    Since:
    2022.0.0
  - public GrailsPlugin[] getFailedLoadPlugins()
  - public GrailsPlugin getFailedPlugin(String name)
  - public GrailsPlugin getGrailsPlugin(String name)
  - public GrailsPlugin getGrailsPlugin(String name, Object version)
  - public GrailsPlugin getGrailsPluginForClassName(String name)
  - @Override
    public Collection<ModuleDescriptor<?>> getModuleDescriptors()
    
    Gets all module descriptors of installed modules.
    Since:
    2022.0.0
  - <M> public Collection<ModuleDescriptor<M>> getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
  - public GrailsPlugin getPluginForClass(Class<?> theClass)
  - public GrailsPlugin getPluginForInstance(Object instance)
  - public String getPluginPath(String name)
  - public String getPluginPath(String name, boolean forceCamelCase)
  - public String getPluginPathForClass(Class<?> theClass)
  - public String getPluginPathForInstance(Object instance)
  - public Resource[] getPluginResources()
  - public String getPluginViewsPathForClass(Class<?> theClass)
  - public String getPluginViewsPathForInstance(Object instance)
  - public boolean hasGrailsPlugin(String name)
  - public void informOfClassChange(Class<?> aClass)
  - @SuppressWarnings({ "rawtypes", "unchecked" })
    public void informOfClassChange(File file, Class<?> cls)
  - public void informOfFileChange(File file)
  - @Override
    public void informPluginsOfConfigChange()
  - public boolean isInitialised()
    
    Returns:
    the initialised
  - protected boolean isPluginDisabledForProfile(GrailsPlugin plugin)
  - public boolean isShutdown()
  - public void onStartup(Map<String, Object> event)
  - public void registerProvidedArtefacts(GrailsApplication app)
  - @Override
    @SuppressWarnings("unchecked")
    public void registerProvidedModules()
  - public void setApplication(GrailsApplication application)
  - public void setApplicationContext(ApplicationContext applicationContext)
  - @Override
    public void setApplicationStartup(ApplicationStartup applicationStartup)
  - public void setLoadCorePlugins(boolean shouldLoadCorePlugins)
  - @Override
    public void setPluginFilter(PluginFilter pluginFilter)
  - public void shutdown()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class AbstractGrailsPluginManager

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String CONFIG_FILE

protected GrailsApplication application

protected ApplicationContext applicationContext

protected Map<String, GrailsPlugin> classNameToPluginMap

protected Map<String, GrailsPlugin> failedPlugins

protected boolean initialised

protected boolean loadCorePlugins

protected List<GrailsPlugin> loadedPlugins

protected ModuleDescriptorFactory moduleDescriptorFactory

protected Set<Class<?>> pluginClasses

protected Resource[] pluginResources

protected Map<String, GrailsPlugin> plugins

protected boolean shutdown

Constructor Detail

public AbstractGrailsPluginManager(GrailsApplication application)

Method Detail

public void addUserPlugin(Class<?> pluginClass)

protected void checkInitialised()

@Overridepublic Object convert(NullSafeNavigator source)

public void doArtefactConfiguration()

public void doDynamicMethods()

public void doDynamicModules()

public void doPostProcessing(ApplicationContext ctx)

public void doRuntimeConfiguration(RuntimeSpringConfiguration springConfig)

public void doRuntimeConfiguration(String pluginName, RuntimeSpringConfiguration springConfig)

public GrailsPlugin[] getAllPlugins()

public GrailsApplication getApplication()

@Overridepublic ApplicationStartup getApplicationStartup()

<D extends ModuleDescriptor<?>> @Overridepublic List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)

public GrailsPlugin[] getFailedLoadPlugins()

public GrailsPlugin getFailedPlugin(String name)

public GrailsPlugin getGrailsPlugin(String name)

public GrailsPlugin getGrailsPlugin(String name, Object version)

public GrailsPlugin getGrailsPluginForClassName(String name)

@Overridepublic Collection<ModuleDescriptor<?>> getModuleDescriptors()

<M> public Collection<ModuleDescriptor<M>> getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)

public GrailsPlugin getPluginForClass(Class<?> theClass)

public GrailsPlugin getPluginForInstance(Object instance)

public String getPluginPath(String name)

public String getPluginPath(String name, boolean forceCamelCase)

public String getPluginPathForClass(Class<?> theClass)

public String getPluginPathForInstance(Object instance)

public Resource[] getPluginResources()

public String getPluginViewsPathForClass(Class<?> theClass)

public String getPluginViewsPathForInstance(Object instance)

public boolean hasGrailsPlugin(String name)

public void informOfClassChange(Class<?> aClass)

@SuppressWarnings({ "rawtypes", "unchecked" })public void informOfClassChange(File file, Class<?> cls)

public void informOfFileChange(File file)

@Overridepublic void informPluginsOfConfigChange()

public boolean isInitialised()

protected boolean isPluginDisabledForProfile(GrailsPlugin plugin)

public boolean isShutdown()

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

public void registerProvidedArtefacts(GrailsApplication app)

@Override@SuppressWarnings("unchecked")public void registerProvidedModules()

public void setApplication(GrailsApplication application)

public void setApplicationContext(ApplicationContext applicationContext)

@Overridepublic void setApplicationStartup(ApplicationStartup applicationStartup)

public void setLoadCorePlugins(boolean shouldLoadCorePlugins)

@Overridepublic void setPluginFilter(PluginFilter pluginFilter)

public void shutdown()

@Override
public Object convert(NullSafeNavigator source)

@Override
public ApplicationStartup getApplicationStartup()

<D extends ModuleDescriptor<?>> @Override
public List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)

@Override
public Collection<ModuleDescriptor<?>> getModuleDescriptors()

@SuppressWarnings({ "rawtypes", "unchecked" })
public void informOfClassChange(File file, Class<?> cls)

@Override
public void informPluginsOfConfigChange()

@Override
@SuppressWarnings("unchecked")
public void registerProvidedModules()

@Override
public void setApplicationStartup(ApplicationStartup applicationStartup)

@Override
public void setPluginFilter(PluginFilter pluginFilter)