Package org.sonar.updatecenter.common

Class PluginManifest

java.lang.Object

org.sonar.updatecenter.common.PluginManifest

public final class PluginManifest
extends Object

This class loads Sonar plugin metadata from JAR manifest.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_PLUGIN
static final String	BUILD_DATE
static final String	DEPENDENCIES
static final String	DESCRIPTION
static final String	DEVELOPERS
static final String	DISPLAY_VERSION
static final String	HOMEPAGE
static final String	IMPLEMENTATION_BUILD
static final String	ISSUE_TRACKER_URL
static final String	KEY
static final String	LICENSE
static final String	MAIN_CLASS
static final String	NAME
static final String	ORGANIZATION
static final String	ORGANIZATION_URL
static final String	REQUIRE_PLUGINS
static final String	REQUIRED_FOR_LANGUAGES
static final String	SONAR_VERSION
static final String	SONARLINT_SUPPORTED
static final String	SOURCES_URL
static final String	TERMS_CONDITIONS_URL
static final String	USE_CHILD_FIRST_CLASSLOADER
static final String	VERSION

Constructor Summary

Constructors

Constructor	Description
PluginManifest()
PluginManifest(File file)	Load the manifest from a JAR file.
PluginManifest(Manifest manifest)

Method Summary

Modifier and Type	Method	Description
String	getBasePlugin()
Date	getBuildDate()
String[]	getDependencies()
String	getDescription()
String[]	getDevelopers()
String	getDisplayVersion()
String	getHomepage()
String	getImplementationBuild()
String	getIssueTrackerUrl()
String	getKey()
String	getLicense()
String	getMainClass()
String	getName()
String	getOrganization()
String	getOrganizationUrl()
String[]	getRequiredForLanguages()
String[]	getRequirePlugins()
String	getSonarVersion()
String	getSourcesUrl()
String	getTermsConditionsUrl()
String	getVersion()
boolean	isSonarLintSupported()
boolean	isUseChildFirstClassLoader()
boolean	isValid()
PluginManifest	setBasePlugin(String key)
PluginManifest	setBuildDate(Date buildDate)
PluginManifest	setDependencies(String[] dependencies)
PluginManifest	setDescription(String description)
PluginManifest	setDevelopers(String[] developers)
PluginManifest	setDisplayVersion(String displayVersion)
PluginManifest	setHomepage(String homepage)
PluginManifest	setImplementationBuild(String implementationBuild)
PluginManifest	setIssueTrackerUrl(String issueTrackerUrl)
PluginManifest	setKey(String key)
PluginManifest	setLicense(String license)
PluginManifest	setMainClass(String mainClass)
PluginManifest	setName(String name)
PluginManifest	setOrganization(String organization)
PluginManifest	setOrganizationUrl(String url)
PluginManifest	setRequiredForLanguages(String[] requiredForLanguages)
PluginManifest	setRequirePlugins(String[] requirePlugins)
PluginManifest	setSonarLintSupported(boolean sonarlintSupported)
PluginManifest	setSonarVersion(String sonarVersion)
PluginManifest	setSourcesUrl(String sourcesUrl)
PluginManifest	setTermsConditionsUrl(String termsConditionsUrl)
PluginManifest	setUseChildFirstClassLoader(boolean useChildFirstClassLoader)
PluginManifest	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

MAIN_CLASS

public static final String MAIN_CLASS

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

ORGANIZATION

public static final String ORGANIZATION

See Also:

• Constant Field Values

ORGANIZATION_URL

public static final String ORGANIZATION_URL

See Also:

• Constant Field Values

LICENSE

public static final String LICENSE

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

SONAR_VERSION

public static final String SONAR_VERSION

See Also:

• Constant Field Values

DEPENDENCIES

public static final String DEPENDENCIES

See Also:

• Constant Field Values

HOMEPAGE

public static final String HOMEPAGE

See Also:

• Constant Field Values

TERMS_CONDITIONS_URL

public static final String TERMS_CONDITIONS_URL

See Also:

• Constant Field Values

BUILD_DATE

public static final String BUILD_DATE

See Also:

• Constant Field Values

ISSUE_TRACKER_URL

public static final String ISSUE_TRACKER_URL

See Also:

• Constant Field Values

REQUIRE_PLUGINS

public static final String REQUIRE_PLUGINS

See Also:

• Constant Field Values

USE_CHILD_FIRST_CLASSLOADER

public static final String USE_CHILD_FIRST_CLASSLOADER

Since:

0.3

See Also:

• Constant Field Values

BASE_PLUGIN

public static final String BASE_PLUGIN

Since:

1.1

See Also:

• Constant Field Values

IMPLEMENTATION_BUILD

public static final String IMPLEMENTATION_BUILD

Since:

1.3

See Also:

• Constant Field Values

SOURCES_URL

public static final String SOURCES_URL

Since:

1.4

See Also:

• Constant Field Values

DEVELOPERS

public static final String DEVELOPERS

Since:

1.4

See Also:

• Constant Field Values

SONARLINT_SUPPORTED

public static final String SONARLINT_SUPPORTED

Since:

1.16

See Also:

• Constant Field Values

DISPLAY_VERSION

public static final String DISPLAY_VERSION

Since:

1.18

See Also:

• Constant Field Values

REQUIRED_FOR_LANGUAGES

public static final String REQUIRED_FOR_LANGUAGES

Since:

1.31

See Also:

• Constant Field Values

Constructor Details

PluginManifest

public PluginManifest(File file)
               throws IOException

Load the manifest from a JAR file.

Throws:

IOException

PluginManifest

public PluginManifest(Manifest manifest)

Parameters:

manifest - can not be null

PluginManifest

public PluginManifest()

Method Details

getKey

public String getKey()

setKey

public PluginManifest setKey(String key)

getName

public String getName()

setName

public PluginManifest setName(String name)

getRequirePlugins

public String[] getRequirePlugins()

Since:

3.5

setRequirePlugins

public PluginManifest setRequirePlugins(@Nullable
 String[] requirePlugins)

Since:

3.5

getDescription

public String getDescription()

setDescription

public PluginManifest setDescription(String description)

getOrganization

public String getOrganization()

setOrganization

public PluginManifest setOrganization(String organization)

getOrganizationUrl

public String getOrganizationUrl()

setOrganizationUrl

public PluginManifest setOrganizationUrl(String url)

getLicense

public String getLicense()

setLicense

public PluginManifest setLicense(String license)

getVersion

public String getVersion()

setVersion

public PluginManifest setVersion(String version)

getDisplayVersion

public String getDisplayVersion()

setDisplayVersion

public PluginManifest setDisplayVersion(String displayVersion)

getSonarVersion

public String getSonarVersion()

setSonarVersion

public PluginManifest setSonarVersion(String sonarVersion)

getMainClass

public String getMainClass()

setMainClass

public PluginManifest setMainClass(String mainClass)

getDependencies

public String[] getDependencies()

setDependencies

public PluginManifest setDependencies(@Nullable
 String[] dependencies)

getBuildDate

public Date getBuildDate()

setBuildDate

public PluginManifest setBuildDate(@Nullable
 Date buildDate)

getHomepage

public String getHomepage()

setHomepage

public PluginManifest setHomepage(String homepage)

getTermsConditionsUrl

public String getTermsConditionsUrl()

setTermsConditionsUrl

public PluginManifest setTermsConditionsUrl(String termsConditionsUrl)

getIssueTrackerUrl

public String getIssueTrackerUrl()

setIssueTrackerUrl

public PluginManifest setIssueTrackerUrl(String issueTrackerUrl)

isUseChildFirstClassLoader

public boolean isUseChildFirstClassLoader()

Since:

0.3

setUseChildFirstClassLoader

public PluginManifest setUseChildFirstClassLoader(boolean useChildFirstClassLoader)

Since:

0.3

isSonarLintSupported

public boolean isSonarLintSupported()

Since:

1.16

setSonarLintSupported

public PluginManifest setSonarLintSupported(boolean sonarlintSupported)

Since:

1.16

getBasePlugin

public String getBasePlugin()

Since:

1.1

setBasePlugin

public PluginManifest setBasePlugin(String key)

Since:

1.1

getImplementationBuild

public String getImplementationBuild()

Since:

1.3

setImplementationBuild

public PluginManifest setImplementationBuild(String implementationBuild)

Since:

1.3

getSourcesUrl

public String getSourcesUrl()

Since:

1.4

setSourcesUrl

public PluginManifest setSourcesUrl(String sourcesUrl)

Since:

1.4

getDevelopers

public String[] getDevelopers()

Since:

1.4

setDevelopers

public PluginManifest setDevelopers(String[] developers)

Since:

1.4

getRequiredForLanguages

public String[] getRequiredForLanguages()

Since:

1.31

setRequiredForLanguages

public PluginManifest setRequiredForLanguages(String[] requiredForLanguages)

Since:

1.31

toString

public String toString()

Overrides:

toString in class Object

isValid

public boolean isValid()