Field Detail

• public static final java.util.List<java.lang.String> DEFAULT_CONFIG_IGNORE_LIST

  Default config keys to ignore when loading plugin configuration.

• public static final java.lang.String GRAILS_PLUGIN_SUFFIX

  The naming suffix required for Grails plugin implementation classes.

• public static final java.lang.String PLUGIN_GRAILS_VERSION_FIELD

  The plugin property that declares the supported Grails version expression.

• public static final java.lang.String PLUGIN_GROOVY_CONFIG

  The filename for Groovy ConfigSlurper-based plugin configuration.

• public static final java.lang.String PLUGIN_GROOVY_CONFIG_PATH

  The relative lookup path for Groovy-based plugin configuration.

• public static final java.lang.String PLUGIN_XML_PATTERN

  The classpath location of the Grails plugin descriptor XML files.

• public static final java.lang.String PLUGIN_YML_CONFIG

  The filename for YAML-based plugin configuration.

• public static final java.lang.String PLUGIN_YML_CONFIG_PATH

  The relative lookup path for YAML-based plugin configuration.

• public static final java.lang.String WILDCARD_OBSERVER_PATTERN

  The wildcard pattern used to indicate that a plugin observes all other plugins, i.e., it should be notified of events from all plugins regardless of name.

Method Detail

• public static PluginInfo createPluginInfo(java.lang.Class<?> pluginClass, Resource descriptorResource, boolean dynamic)

  Creates a PluginInfo for a single plugin class using a synthetic descriptor.

  Parameters:

  pluginClass - the plugin implementation class

  descriptorResource - the descriptor resource associated with the plugin, if any

  dynamic - whether the plugin originated from a dynamic plugin configuration

  Returns:

  the created plugin info

• public static PluginInfo createPluginInfoByDescriptor(java.lang.Class<?> pluginClass, PluginDescriptor descriptor, boolean dynamic)

  Creates a PluginInfo for a plugin class using the supplied descriptor.

  Parameters:

  pluginClass - the plugin implementation class

  descriptor - the descriptor that produced the plugin

  dynamic - whether the plugin originated from a dynamic plugin configuration

  Returns:

  the created plugin info

• public static java.util.Map<java.lang.String, java.util.Set<java.lang.Object>> evaluateIncludeExcludeProperty(java.lang.Object pluginBean, java.lang.String name, java.util.function.Function<java.lang.Object, java.lang.Object> converter)

  Evaluates an include/exclude style plugin property into a normalized lookup map.

  The property may be declared either as a map containing includes and excludes entries, or as a single include value. Values are converted through the supplied converter before being stored.

  Parameters:

  pluginBean - the plugin bean containing the property

  name - the property name to evaluate

  converter - a converter applied to each include/exclude value before storage

  Returns:

  the normalized include/exclude map

• @groovy.transform.Internal
  public static java.lang.String[] evaluateObservedPlugins(BeanWrapper beanWrapper, java.lang.Object pluginInstance)

  Extracts the plugin names observed by the supplied plugin instance.

  Parameters:

  beanWrapper - the wrapper used to inspect plugin properties

  pluginInstance - the plugin instance being inspected

  Returns:

  the observed plugin names, or an empty array if none are declared

• @groovy.transform.Internal
  public static PluginUtils.PluginDependencies evaluatePluginDependencies(BeanWrapper beanWrapper, java.lang.Object plugin)

  Extracts the declared plugin dependencies.

  Parameters:

  beanWrapper - the wrapper used to inspect plugin properties

  plugin - the plugin instance being inspected

  Returns:

  the dependency names together with the raw dependency map

• @groovy.transform.Internal
  public static java.util.Map<java.lang.String, java.util.Set<java.lang.Object>> evaluatePluginEnvironments(BeanWrapper beanWrapper, java.lang.Object pluginInstance)

  Extracts the environment include/exclude configuration declared by the supplied plugin.

  Parameters:

  beanWrapper - the wrapper used to inspect plugin properties

  pluginInstance - the plugin instance being inspected

  Returns:

  the environment include/exclude map, or an empty map if none is declared

• @groovy.transform.Internal
  public static java.lang.String[] evaluatePluginEvictionPolicy(BeanWrapper beanWrapper, java.lang.Object pluginInstance)

  Extracts the plugin names evicted by the supplied plugin.

  Parameters:

  beanWrapper - the wrapper used to inspect plugin properties

  pluginInstance - the plugin instance being inspected

  Returns:

  the declared evicted plugin names, or an empty array if none are declared

• @groovy.transform.Internal
  public static java.lang.String[] evaluatePluginLoadAfters(BeanWrapper beanWrapper, java.lang.Object pluginInstance)

  Extracts the plugin names this plugin prefers to load after.

  Parameters:

  beanWrapper - the wrapper used to inspect plugin properties

  pluginInstance - the plugin instance being inspected

  Returns:

  the declared load-after plugin names, or an empty array if none are declared

• @groovy.transform.Internal
  public static java.lang.String[] evaluatePluginLoadBefores(BeanWrapper beanWrapper, java.lang.Object pluginInstance)

  Extracts the plugin names this plugin prefers to load before.

  Parameters:

  beanWrapper - the wrapper used to inspect plugin properties

  pluginInstance - the plugin instance being inspected

  Returns:

  the declared load-before plugin names, or an empty array if none are declared

• @groovy.transform.Internal
  public static java.lang.String evaluatePluginStatus(BeanWrapper beanWrapper, java.lang.Object plugin)

  Determines whether the supplied plugin is enabled.

  Parameters:

  beanWrapper - the wrapper used to inspect plugin properties

  plugin - the plugin instance being inspected

  Returns:

  the normalized plugin status string

• @groovy.transform.Internal
  public static java.lang.String evaluatePluginVersion(BeanWrapper beanWrapper, java.lang.Object plugin, java.lang.String name)

  Extracts the declared plugin version.

  throws:

  PluginException if the plugin does not declare a version

  Parameters:

  beanWrapper - the wrapper used to inspect plugin properties

  plugin - the plugin instance being inspected

  name - the logical plugin name used in error messages

  Returns:

  the declared plugin version

• public static PluginMetadata extractPluginMetadata(java.lang.Class<?> pluginClass)

  Extracts plugin metadata (loadAfter, loadBefore, dependsOn) from a plugin class without requiring a full GrailsApplication or plugin manager.

  The plugin class is instantiated to read its properties via a BeanWrapper, mirroring the approach used by DefaultGrailsPlugin. The dependsOn property is a Map<String, String> where keys are dependency plugin names and values are version constraints; only the keys are extracted.

  Parameters:

  pluginClass - the plugin class to extract metadata from

  Returns:

  a PluginMetadata instance, or null if the class is not a valid Grails plugin

• public static Resource getConfigurationResource(java.lang.Class<?> pluginClass, java.lang.String configPath)

  Finds a plugin configuration resource at the given path relative to the plugin class, delegating to IOUtils#findResourceRelativeToClass#findResourceRelativeToClass.

  Parameters:

  pluginClass - the plugin class to resolve relative to

  configPath - the path to probe (for example "/plugin.yml")

  Returns:

  the resource wrapping the configuration URL, or null if no such resource exists

• public static java.lang.String getLogicalPluginName(java.lang.Class<?> pluginClass)

  Derives the logical plugin name from the plugin class, following Grails conventions.

  For example, org.grails.plugins.CoreGrailsPlugin becomes core. This delegates to GrailsNameUtils#getLogicalPropertyName#getLogicalPropertyName with the "GrailsPlugin" suffix.

  Parameters:

  pluginClass - the plugin class

  Returns:

  the logical plugin name

• public static java.lang.String getLogicalPluginNameFromClassName(java.lang.String name)

  Derives the logical plugin name from a plugin class name.

  Parameters:

  name - the plugin class simple name

  Returns:

  the logical plugin name with the GRAILS_PLUGIN_SUFFIX removed

• public static boolean isGrailsPluginClassNamedCorrectly(java.lang.Class<?> pluginClass)

  Determines whether the supplied class follows Grails plugin naming conventions.

  Parameters:

  pluginClass - the class to inspect

  Returns:

  true if the class name ends with GRAILS_PLUGIN_SUFFIX

• public static boolean isGrailsPluginLoadable(java.lang.Class<?> pluginClass)

  Determines whether the supplied class can be loaded as a Grails plugin.

  Parameters:

  pluginClass - the class to inspect

  Returns:

  true if the class is non-null, non-abstract, and not the framework base plugin class

• public static boolean isPluginVersionCompatible(java.lang.String pluginVersion, java.lang.String pluginSupportedVersionRange, java.lang.String grailsVersion, java.lang.String pluginDescription)

  Determines whether a plugin's declared Grails version range is compatible with the target Grails version.

  This method supports exact version checks and version ranges as interpreted by GrailsVersionUtils. Compatibility problems are logged and reported by returning false.

  Parameters:

  pluginVersion - the plugin version used in log messages

  pluginSupportedVersionRange - the Grails version or version range declared by the plugin

  grailsVersion - the target Grails version to test against

  pluginDescription - the plugin description used in log messages

  Returns:

  true if the plugin should be considered compatible with the supplied Grails version

• public static java.lang.String normalizePluginName(java.lang.String name)

  Normalizes a plugin name into a Grails logical property form.

  Hyphen-separated names are converted to lower camel case so lookups can match either external plugin names such as some-plugin or logical names such as somePlugin.

  Parameters:

  name - the plugin name to normalize

  Returns:

  the normalized plugin name

• public static Resource readPluginConfiguration(java.lang.Class<?> pluginClass)

  Resolves the plugin configuration resource relative to the supplied plugin class.

  The lookup probes for both plugin.yml and plugin.groovy. If both exist, a java.lang.RuntimeException is thrown because a plugin may define only one configuration source.

  Parameters:

  pluginClass - the plugin class to resolve relative to

  Returns:

  the configuration resource, or null if no config file is present

• public static java.util.List<PluginDescriptor> scanPluginDescriptorResources(java.lang.ClassLoader classLoader)

  Scans all META-INF/grails-plugin.xml resources visible to the supplied class loader.

  Each descriptor is parsed with PluginXmlHandler and returned as a PluginDescriptor containing the descriptor resource, declared plugin implementation classes, and any provided class names. Invalid descriptors are logged and skipped, so discovery can continue.

  Parameters:

  classLoader - the class loader to scan for plugin descriptors

  Returns:

  a list of PluginDescriptor records, one per META-INF/grails-plugin.xml resource found on the classpath

• public static java.util.List<java.lang.String> scanPluginDescriptors(java.lang.ClassLoader classLoader)

  Convenience method that scans all META-INF/grails-plugin.xml resources and returns just the plugin class names.

  Parameters:

  classLoader - the class loader to scan for plugin descriptors

  Returns:

  a list of fully qualified plugin class names discovered from META-INF/grails-plugin.xml descriptors

• public static boolean supportsValueInIncludeExcludeMap(java.util.Map<java.lang.String, java.util.Set<java.lang.Object>> includeExcludeMap, java.lang.Object value)

  Determines whether a value is permitted by a normalized include/exclude map.

  An empty map allows every value. If an include set is present, only included values are supported. Otherwise, values are rejected only when they appear in the exclude set.

  Parameters:

  includeExcludeMap - the include/exclude map to evaluate

  value - the value to test

  Returns:

  true if the value is permitted by the include/exclude rules