Package org.jivesoftware.openfire.container

Class PluginMetadata

java.lang.Object

org.jivesoftware.openfire.container.PluginMetadata

Direct Known Subclasses:

AvailablePlugin

public class PluginMetadata
extends Object

A bean-like representation of the metadata of a plugin.

Author:

Guus der Kinderen, guus.der.kinderen@gmail.com

Constructor Summary

Constructors

Constructor	Description
PluginMetadata(String name, String canonicalName, String description, Version version, String author, URL icon, URL changelog, URL readme, String license, Version minServerVersion, Version priorToServerVersion, JavaSpecVersion minJavaVersion, boolean csrfProtectionEnabled)

Method Summary

Modifier and Type	Method	Description
String	getAuthor()
String	getCanonicalName()
URL	getChangelog()
String	getDescription()
String	getHashCode()
URL	getIcon()
static PluginMetadata	getInstance(Path pluginDir)	Constructs a metadata object based on a plugin.
static PluginMetadata	getInstance(Plugin plugin)	Constructs a metadata object based on a plugin.
String	getLicense()
JavaSpecVersion	getMinJavaVersion()
Version	getMinServerVersion()
String	getName()
Version	getPriorToServerVersion()
URL	getReadme()
Version	getVersion()
boolean	isCsrfProtectionEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginMetadata

public PluginMetadata(String name,
                      String canonicalName,
                      String description,
                      Version version,
                      String author,
                      URL icon,
                      URL changelog,
                      URL readme,
                      String license,
                      Version minServerVersion,
                      Version priorToServerVersion,
                      JavaSpecVersion minJavaVersion,
                      boolean csrfProtectionEnabled)

Method Detail

getInstance

public static PluginMetadata getInstance(Path pluginDir)

Constructs a metadata object based on a plugin. The plugin must be installed in Openfire.

Parameters:

pluginDir - the path of the plugin directory (cannot be null)

Returns:

Metadata for the plugin (never null).

getInstance

public static PluginMetadata getInstance(Plugin plugin)

Constructs a metadata object based on a plugin. The plugin must be installed in Openfire.

Parameters:

plugin - The plugin (cannot be null)

Returns:

Metadata for the plugin (never null).

getName

public String getName()

getCanonicalName

public String getCanonicalName()

getDescription

public String getDescription()

getVersion

public Version getVersion()

getAuthor

public String getAuthor()

getIcon

public URL getIcon()

getChangelog

public URL getChangelog()

getReadme

public URL getReadme()

getLicense

public String getLicense()

getMinServerVersion

public Version getMinServerVersion()

getPriorToServerVersion

public Version getPriorToServerVersion()

getMinJavaVersion

public JavaSpecVersion getMinJavaVersion()

getHashCode

public String getHashCode()

isCsrfProtectionEnabled

public boolean isCsrfProtectionEnabled()