Method Detail

• public PluginInfo findPlugin(java.lang.String pluginName)

  Finds a discovered plugin by name.

  Parameters:

  pluginName - a plugin name to search for; implementations may normalize the name before lookup

  Returns:

  the plugin information if found, otherwise null

• public PluginInfo findPlugin(java.lang.String pluginName, java.lang.Object version)

  Finds a discovered plugin by name and required version.

  Parameters:

  pluginName - a plugin name to search for; implementations may normalize the name before lookup

  version - the required version of the plugin

  Returns:

  the matching plugin if it satisfies the required version, otherwise null

• public java.util.Collection<PluginInfo> findPluginObservers(PluginInfo plugin)

  Finds plugins that observe the supplied plugin.

  Parameters:

  plugin - the plugin to get the observers for

  Returns:

  the plugins observing the given plugin, or an empty collection if there are none

• public java.util.Collection<PluginInfo> getDynamicPlugins()

  Returns plugins supplied dynamically instead of being discovered from classpath descriptors.

  This is most commonly used by tests that configure plugin classes or resources directly.

  Returns:

  dynamically configured plugins discovered outside the standard classpath descriptor scan

• public PluginInfo getFailedPlugin(java.lang.String name)

  Returns a plugin that failed during discovery or dependency resolution.

  Parameters:

  name - the name of the plugin; implementations may normalize the name before lookup

  Returns:

  the failed plugin, or null if no matching failed plugin exists

• public java.util.Collection<PluginInfo> getFailedPlugins()

  Returns every plugin that failed during discovery or dependency resolution.

  Returns:

  the plugins that could not be loaded successfully

• public Resource[] getPluginResources()

  Returns the configured dynamic plugin resources.

  Returns:

  the dynamic plugin resources currently configured for discovery

• public java.util.List<PluginInfo> getPluginsInLoadOrder()

  Returns the discovered plugins in their effective load order.

  Returns:

  the order in which plugins should be loaded

• public java.util.List<PluginInfo> getPluginsInTopologicalOrder()

  Returns the discovered plugins in topological order.

  Returns:

  plugins ordered by dependency and declared load-before/load-after relationships

• public boolean hasFailedPlugin(java.lang.String name)

  Determines whether a plugin failed during discovery or dependency resolution.

  Parameters:

  name - the name of the plugin; implementations may normalize the name before lookup

  Returns:

  true if the named plugin could not be loaded successfully

• public boolean hasPlugin(java.lang.String name)

  Determines whether a plugin with the given name has been discovered.

  Parameters:

  name - the name of the plugin; implementations may normalize the name before lookup

  Returns:

  true if a plugin with the given name exists, otherwise false

• public void init(Environment environment)

  Initializes plugin discovery for the supplied environment.

  This method is typically invoked during GrailsEnvironmentPostProcessor so filtering and ordering are available before the main application context finishes bootstrapping.

  Parameters:

  environment - the environment used to determine plugin filtering and ordering

• public void reset()

  Resets the discovery state so plugins can be discovered again.

  Warning: This should only be done in controlled environments, usually during testing.

• public void setClasspathPluginsRequired(boolean requireClasspathPlugin)

  Controls whether at least one classpath plugin is required.

  Parameters:

  requireClasspathPlugin - if true, classpath plugins will be required to be present

• public void setLoadPluginsFromClasspath(boolean loadClasspathPlugins)

  Enables or disables discovery of plugins from classpath descriptors.

  Parameters:

  loadClasspathPlugins - true if plugins should be loaded from the classpath, otherwise no classpath plugins will be searched

• public void setPluginClasses(java.lang.Class<?>[] pluginClasses)

  Configures explicit plugin classes to be treated as dynamic plugins.

  Parameters:

  pluginClasses - the dynamically supplied plugin classes

• public void setPluginFilter(PluginFilter filter)

  Overrides the plugin filter used during discovery.

  Parameters:

  filter - an override to filter plugins that are found during the discovery process

• public void setPluginResources(Resource[] pluginResources)

  Configures Groovy plugin resources to be treated as dynamic plugins.

  Parameters:

  pluginResources - the resources containing dynamically defined plugin classes

• public void setPluginResources(java.lang.String[] pluginResources)

  Configures resource locations to search for dynamically defined plugins.

  Parameters:

  pluginResources - the resource location patterns containing dynamically defined plugins

• public void setPluginResources(java.lang.String resourcePath)

  Configures a single resource location to search for dynamically defined plugins.

  Parameters:

  resourcePath - the resource location containing dynamically defined plugins