com.atlassian.confluence.it.plugin

Class ClasspathUploadablePlugin

java.lang.Object

com.atlassian.confluence.it.plugin.ClasspathUploadablePlugin

All Implemented Interfaces:

Plugin, UploadablePlugin

Direct Known Subclasses:

SpringComponentUploadablePlugin

public class ClasspathUploadablePlugin
extends Object
implements UploadablePlugin

An uploadable plugin that can be loaded as a classpath resource via ClassLoader.getResource(String).

Field Summary

Fields inherited from interface com.atlassian.confluence.it.plugin.Plugin

PLUGIN_DESCRIPTOR_FILENAME

Constructor Summary

Constructors

Constructor and Description
ClasspathUploadablePlugin(String key, String displayName, String resourceName) Specifies a plugin to be loaded from a classpath resource.

Method Summary

Modifier and Type	Method and Description
String	getDisplayName()
File	getFile()
String	getKey() The plugin key of the plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathUploadablePlugin

public ClasspathUploadablePlugin(String key,
                                 String displayName,
                                 String resourceName)

Specifies a plugin to be loaded from a classpath resource.

Parameters:

key - the key of the plugin

displayName - the visible name of the plugin, used to verify its installation

resourceName - the path to the plugin JAR as a classpath resource

Method Detail

getKey

public String getKey()

Description copied from interface: Plugin

The plugin key of the plugin.

Specified by:

getKey in interface Plugin

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Plugin

Returns:

the full name of the plugin, used to ensure that the plugin was uploaded successfully

getFile

public File getFile()

Specified by:

getFile in interface UploadablePlugin

Returns:

the JAR file of the plugin to upload.