public class

ClasspathFilePluginMetadata

extends Object
implements RequiredPluginProvider
java.lang.Object
   ↳ com.atlassian.plugin.metadata.ClasspathFilePluginMetadata

Class Overview

Looks on the classpath for three files named:

  • application-provided-plugins.txt - used to list the plugin keys of all plugins that are provided by the host application
  • application-required-plugins.txt - used to list the plugin keys that are considered required for the application to function correctly
  • application-required-modules.txt - used to list the module keys that are considered required for the application to function correctly
Note that all files in that package space with those names will be included.

All files contents will be used to inform this implementation of plugin keys. This will read the contents all instances of those files into the structures of this class.

The values will determine the plugin metadata for this implementation.

Summary

Public Constructors
ClasspathFilePluginMetadata()
Public Methods
boolean applicationProvided(Plugin plugin)
Set<String> getRequiredModuleKeys()
The set of all of the plugin modules that have been marked as required by the host application.
Set<String> getRequiredPluginKeys()
The set of all of the plugins that have been marked as required by the host application.
boolean required(ModuleDescriptor<?> module)
boolean required(Plugin plugin)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.plugin.metadata.RequiredPluginProvider

Public Constructors

public ClasspathFilePluginMetadata ()

Public Methods

public boolean applicationProvided (Plugin plugin)

public Set<String> getRequiredModuleKeys ()

The set of all of the plugin modules that have been marked as required by the host application.

Returns
  • The set of plugin modules required by the host application, or the empty set.

public Set<String> getRequiredPluginKeys ()

The set of all of the plugins that have been marked as required by the host application.

Returns
  • The set of plugins required by the host application, or the empty set.

public boolean required (ModuleDescriptor<?> module)

public boolean required (Plugin plugin)