com.atlassian.plugin.metadata

Class ClasspathFilePluginMetadata

java.lang.Object

com.atlassian.plugin.metadata.ClasspathFilePluginMetadata

All Implemented Interfaces:

RequiredPluginProvider

public class ClasspathFilePluginMetadata
extends Object
implements RequiredPluginProvider

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.

Since:

2.6

Constructor Summary

Constructors

Constructor and Description
ClasspathFilePluginMetadata()

Method Summary

Modifier and Type	Method and Description
boolean	applicationProvided(Plugin plugin) Is the Plugin provided by (bundled with) the application.
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) Is the ModuleDescriptor required by the application for basic operation.
boolean	required(Plugin plugin) Is the Plugin required by the application for basic operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClasspathFilePluginMetadata

public ClasspathFilePluginMetadata()

Method Detail

applicationProvided

public boolean applicationProvided(Plugin plugin)

Is the Plugin provided by (bundled with) the application.

Parameters:

plugin - the plugin

Returns:

true if the application bundled the plugin.

required

public boolean required(Plugin plugin)

Is the Plugin required by the application for basic operation.

Parameters:

plugin - the plugin

Returns:

true if the application requires the plugin.

required

public boolean required(ModuleDescriptor<?> module)

Is the ModuleDescriptor required by the application for basic operation.

Parameters:

module - the module descriptor

Returns:

true if the application requires the module descriptor.

getRequiredPluginKeys

public Set<String> getRequiredPluginKeys()

Description copied from interface: RequiredPluginProvider

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

Specified by:

getRequiredPluginKeys in interface RequiredPluginProvider

Returns:

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

getRequiredModuleKeys

public Set<String> getRequiredModuleKeys()

Description copied from interface: RequiredPluginProvider

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

Specified by:

getRequiredModuleKeys in interface RequiredPluginProvider

Returns:

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