com.atlassian.plugin

Class PluginPermission

java.lang.Object

com.atlassian.plugin.PluginPermission

public final class PluginPermission
extends Object

Represents a plugin permission as parsed from the plugin descriptor.

A plugin permission here is:

• A name which denotes the permission itself.
• An installation mode which tells whether the permission is required for a given type of installation of the plugin. No installation mode defined means that the permission is always required.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static PluginPermission	ALL
static PluginPermission	EXECUTE_JAVA

Constructor Summary

Constructors

Constructor and Description
PluginPermission(String name)
PluginPermission(String name, InstallationMode installationMode)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Optional<InstallationMode>	getInstallationMode() The installation mode for that permission.
String	getName()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final PluginPermission ALL

EXECUTE_JAVA

public static final PluginPermission EXECUTE_JAVA

Constructor Detail

PluginPermission

public PluginPermission(String name)

PluginPermission

public PluginPermission(String name,
                        InstallationMode installationMode)

Method Detail

getName

public String getName()

getInstallationMode

@Nonnull
public Optional<InstallationMode> getInstallationMode()

The installation mode for that permission.

Returns:

the installation mode as an Optional. If the result is Optional.empty() then this means this permission is always valid, however when it is defined it will only be valid for the given installation mode.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object