AbstractPlugin (Atlassian Plugins - Parent POM 5.1.0 API)

java.lang.Object
- com.atlassian.plugin.impl.AbstractPlugin

All Implemented Interfaces:

Plugin, PluginInternal, Resourced, ScopeAware, Comparable<Plugin>

Direct Known Subclasses:

DefaultDynamicPlugin, OsgiBundlePlugin, OsgiPlugin, StaticPlugin, XmlDynamicPlugin
```
public abstract class AbstractPlugin
extends Object
implements PluginInternal, Comparable<Plugin>
```
Represents the base class for all plugins. Note: This class has a natural ordering that is inconsistent with equals.
p1.equals(p2) == true will give p1.compareTo(p2) == 0 but the opposite is not guaranteed because we keep a map of plugins versus loaders in the DefaultPluginManager .
A plugin with the same key and version may well be loaded from multiple loaders (in fact with UPM it's almost guaranteed) so we CANNOT override equals.

Field Summary

Fields
Modifier and Type Field and Description

protected PluginArtifact pluginArtifact
- Fields inherited from interface com.atlassian.plugin.Plugin
  VERSION_1, VERSION_2, VERSION_3

Fields
Modifier and Type	Field and Description
`protected PluginArtifact`	`pluginArtifact`

Constructor Summary

Constructors
Constructor and Description

AbstractPlugin(PluginArtifact pluginArtifact)

Constructors
Constructor and Description
`AbstractPlugin(PluginArtifact pluginArtifact)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addDynamicModuleDescriptor(ModuleDescriptor<?> module)` Add a module descriptor.
`void`	`addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)`
`static String`	`cleanVersionString(String version)`
`void`	`close()`
`protected boolean`	`compareAndSetPluginState(PluginState requiredExistingState, PluginState desiredState)` Only sets the plugin state if it is in the expected state.
`int`	`compareTo(Plugin otherPlugin)` Compares this Plugin to another Plugin for order.
`boolean`	`containsSystemModule()`
`void`	`disable()` Disables the plugin.
`protected void`	`disableInternal()` Perform any internal disabling logic.
`void`	`enable()` Enables the plugin.
`protected PluginState`	`enableInternal()` Perform any internal enabling logic.
`Set<String>`	`getActivePermissions()`
`Date`	`getDateEnabled()` Obtain the date that the plugin system most recently completed enabling of this plugin.
`Date`	`getDateEnabling()` Obtain the date that the plugin system most recently commenced enabling this plugin.
`Date`	`getDateInstalled()` The date this plugin was installed into the system, is the same as the loaded date for non artifact backed plugins
`Date`	`getDateLoaded()` The date this plugin was loaded into the system.
`PluginDependencies`	`getDependencies()` Determines which plugin keys are dependencies, categorising them as mandatory, optional or dynamic.
`Iterable<ModuleDescriptor<?>>`	`getDynamicModuleDescriptors()`
`String`	`getI18nNameKey()` Returns the i18nKey used to get an internationalised name for this plugin.
`InstallationMode`	`getInstallationMode()` Gets the installation mode
`String`	`getKey()`
`protected org.slf4j.Logger`	`getLog()`
`ModuleDescriptor<?>`	`getModuleDescriptor(String key)` Get the `ModuleDescriptor` for a particular key.
`Collection<ModuleDescriptor<?>>`	`getModuleDescriptors()` Returns the module descriptors for this plugin
`<T> List<ModuleDescriptor<T>>`	`getModuleDescriptorsByModuleClass(Class<T> aClass)` Get the `descriptors` whose module class implements or is assignable from the supplied `Class`.
`String`	`getName()` Returns the non-localised name of this plugin if defined.
`PluginArtifact`	`getPluginArtifact()` Retrieve the original, unprocessed or transformed `PluginArtifact` used to create this plugin instance.
`PluginInformation`	`getPluginInformation()`
`PluginState`	`getPluginState()` Returns this plugin's current state.
`int`	`getPluginsVersion()` Gets the version of the plugins system to handle this plugin
`Set<String>`	`getRequiredPlugins()`
`ResourceDescriptor`	`getResourceDescriptor(String type, String name)` Get a `ResourceDescriptor` of a particular type and name.
`List<ResourceDescriptor>`	`getResourceDescriptors()` Get a `List` of all the `descriptors` .
`ResourceLocation`	`getResourceLocation(String type, String name)` Get a `ResourceLocation` of a particular type and name.
`Optional<String>`	`getScopeKey()`
`boolean`	`hasAllPermissions()`
`void`	`install()` Installs the plugin into any internal, managing container.
`protected void`	`installInternal()` Perform any internal installation logic.
`boolean`	`isBundledPlugin()` Whether the plugin is a "bundled" plugin that can't be removed.
`boolean`	`isEnabledByDefault()`
`boolean`	`isSystemPlugin()` Whether the plugin is a "system" plugin that shouldn't be made visible to the user.
`boolean`	`removeDynamicModuleDescriptor(ModuleDescriptor<?> module)` Remove a module descriptor.
`protected void`	`removeModuleDescriptor(String key)`
`void`	`resolve()` Perform any required resolution.
`void`	`setBundledPlugin(boolean bundledPlugin)` Alters whether the plugin is a "bundled" plugin that can't be removed.
`void`	`setEnabledByDefault(boolean enabledByDefault)`
`void`	`setI18nNameKey(String i18nNameKey)` Sets the i18nKey used to get an internationalised name for this plugin.
`void`	`setKey(String key)`
`void`	`setName(String name)` Sets the non-localised name of this plugin.
`void`	`setPluginInformation(PluginInformation pluginInformation)`
`protected void`	`setPluginState(PluginState state)`
`void`	`setPluginsVersion(int pluginsVersion)` Sets the version of the plugins system
`void`	`setResources(Resourced resources)`
`void`	`setSystemPlugin(boolean system)`
`String`	`toString()`
`void`	`uninstall()` Uninstalls the plugin from any internal container.
`protected void`	`uninstallInternal()` Perform any internal uninstallation logic.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.Plugin
getClassLoader, getResource, getResourceAsStream, isDeleteable, isDynamicallyLoaded, isUninstallable, loadClass

- Field Detail
  - pluginArtifact
```
protected final PluginArtifact pluginArtifact
```
- Constructor Detail
  - AbstractPlugin
```
public AbstractPlugin(PluginArtifact pluginArtifact)
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: Plugin
    
    Returns the non-localised name of this plugin if defined.
    This corresponds to the value of the name field in the plugin's XML configuration file.
    You would expect a plugin developer to fill in one of either name, or i18n-name-key, but the framework does no validation and makes no guarantees that this is the case.
    
    Specified by:
    
    getName in interface Plugin
    
    Returns:
    
    the non-localised name of this plugin if defined, or null.
    
    See Also:
    
    Plugin.getI18nNameKey()
  - setName
```
public void setName(String name)
```
    Description copied from interface: Plugin
    
    Sets the non-localised name of this plugin.
    
    Specified by:
    
    setName in interface Plugin
    
    Parameters:
    
    name - the name.
    
    See Also:
    
    Plugin.getName()
  - getLog
```
protected org.slf4j.Logger getLog()
```
    Returns:
    
    the logger used internally
  - getI18nNameKey
```
public String getI18nNameKey()
```
    Description copied from interface: Plugin
    
    Returns the i18nKey used to get an internationalised name for this plugin.
    This corresponds to the value of the i18n-name-key field in the plugin's XML configuration file.
    You would expect a plugin developer to fill in one of either name, or i18n-name-key, but the framework does no validation and makes no guarantees that this is the case.
    
    Specified by:
    
    getI18nNameKey in interface Plugin
    
    Returns:
    
    the i18n Name Key for this plugin if defined, or null.
    
    See Also:
    
    Plugin.getName()
  - setI18nNameKey
```
public void setI18nNameKey(String i18nNameKey)
```
    Description copied from interface: Plugin
    
    Sets the i18nKey used to get an internationalised name for this plugin.
    
    Specified by:
    
    setI18nNameKey in interface Plugin
    
    Parameters:
    
    i18nNameKey - the i18n Name Key.
    
    See Also:
    
    Plugin.getI18nNameKey()
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface Plugin
  - setKey
```
public void setKey(String key)
```
    Specified by:
    
    setKey in interface Plugin
  - addModuleDescriptor
```
public void addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)
```
    Specified by:
    
    addModuleDescriptor in interface Plugin
  - removeModuleDescriptor
```
protected void removeModuleDescriptor(String key)
```
  - getModuleDescriptors
```
public Collection<ModuleDescriptor<?>> getModuleDescriptors()
```
    Returns the module descriptors for this plugin
    
    Specified by:
    
    getModuleDescriptors in interface Plugin
    
    Returns:
    
    An unmodifiable list of the module descriptors.
  - getModuleDescriptor
```
public ModuleDescriptor<?> getModuleDescriptor(String key)
```
    Description copied from interface: Plugin
    
    Get the ModuleDescriptor for a particular key. Returns null if the plugin does not exist.
    Note: The ModuleDescriptor.getModule() may throw ClassCastException if the expected type is incorrect.
    
    Specified by:
    
    getModuleDescriptor in interface Plugin
    
    Parameters:
    
    key - the String complete key of the module, in the form "org.example.plugin:module-key".
    
    Returns:
    
    the ModuleDescriptor of the expected type.
  - getModuleDescriptorsByModuleClass
```
public <T> List<ModuleDescriptor<T>> getModuleDescriptorsByModuleClass(Class<T> aClass)
```
    Description copied from interface: Plugin
    
    Get the descriptors whose module class implements or is assignable from the supplied Class.
    Note: The ModuleDescriptor.getModule() may throw ClassCastException if the expected type is incorrect. Normally this method would not be supplied with anything other than Object or <?>, unless you are confident in the super type of the module classes this Plugin provides.
    
    Specified by:
    
    getModuleDescriptorsByModuleClass in interface Plugin
    
    Type Parameters:
    
    T - The expected module type of the returned descriptors.
    
    Parameters:
    
    aClass - the super class the descriptors return.
    
    Returns:
    
    the List of descriptors of the expected type.
  - getPluginState
```
public PluginState getPluginState()
```
    Description copied from interface: Plugin
    
    Returns this plugin's current state.
    
    Specified by:
    
    getPluginState in interface Plugin
    
    Returns:
    
    the current state of the plugin.
  - setPluginState
```
protected void setPluginState(PluginState state)
```
  - compareAndSetPluginState
```
protected boolean compareAndSetPluginState(PluginState requiredExistingState,
                                           PluginState desiredState)
```
    Only sets the plugin state if it is in the expected state.
    
    Parameters:
    
    requiredExistingState - The expected state
    
    desiredState - The desired state
    
    Returns:
    
    True if the set was successful, false if not in the expected state
    
    Since:
    
    2.4
  - isEnabledByDefault
```
public boolean isEnabledByDefault()
```
    Specified by:
    
    isEnabledByDefault in interface Plugin
  - setEnabledByDefault
```
public void setEnabledByDefault(boolean enabledByDefault)
```
    Specified by:
    
    setEnabledByDefault in interface Plugin
  - getPluginsVersion
```
public int getPluginsVersion()
```
    Description copied from interface: Plugin
    
    Gets the version of the plugins system to handle this plugin
    
    Specified by:
    
    getPluginsVersion in interface Plugin
    
    Returns:
    
    The plugins version. If undefined, assumed to be 1.
  - setPluginsVersion
```
public void setPluginsVersion(int pluginsVersion)
```
    Description copied from interface: Plugin
    
    Sets the version of the plugins system
    
    Specified by:
    
    setPluginsVersion in interface Plugin
    
    Parameters:
    
    pluginsVersion - The version
  - getPluginInformation
```
public PluginInformation getPluginInformation()
```
    Specified by:
    
    getPluginInformation in interface Plugin
  - setPluginInformation
```
public void setPluginInformation(PluginInformation pluginInformation)
```
    Specified by:
    
    setPluginInformation in interface Plugin
  - setResources
```
public void setResources(Resourced resources)
```
    Specified by:
    
    setResources in interface Plugin
  - getResourceDescriptors
```
public List<ResourceDescriptor> getResourceDescriptors()
```
    Description copied from interface: Resourced
    
    Get a List of all the descriptors .
    Note: since 2.2 this list must be immutable, previously modifying this list could modify the underlying list.
    
    Specified by:
    
    getResourceDescriptors in interface Resourced
    
    Returns:
    
    all resource descriptors this object supports.
  - getResourceLocation
```
public ResourceLocation getResourceLocation(String type,
                                            String name)
```
    Description copied from interface: Resourced
    
    Get a ResourceLocation of a particular type and name.
    
    Specified by:
    
    getResourceLocation in interface Resourced
    
    Returns:
    
    the specified resource location if found, null otherwise.
  - getResourceDescriptor
```
public ResourceDescriptor getResourceDescriptor(String type,
                                                String name)
```
    Description copied from interface: Resourced
    
    Get a ResourceDescriptor of a particular type and name.
    
    Specified by:
    
    getResourceDescriptor in interface Resourced
    
    Returns:
    
    the specified resource descriptor if found, null otherwise.
  - enable
```
public void enable()
```
    Description copied from interface: Plugin
    
    Enables the plugin. Unless an exception is thrown, the plugin should then be in either the PluginState.ENABLING or PluginState.ENABLED state. If the plugin is already in the PluginState.ENABLING or PluginState.ENABLED state, nothing will happen.
    
    Specified by:
    
    enable in interface Plugin
  - enableInternal
```
protected PluginState enableInternal()
                              throws PluginException
```
    Perform any internal enabling logic. This method is called by enable to allow subclasses to customize enable behaviour. If a PluginState other than PluginState.PENDING is returned, it will be passed to setPluginState(PluginState). If a subclass returns PluginState.PENDING, no state is set, and it is assumed the subclass has taken responsibility for transitioning state via direct calls to setPluginState(PluginState). Subclasses should only throw PluginException.
    
    Returns:
    
    One of PluginState.ENABLED, PluginState.ENABLING, or PluginState.PENDING
    
    Throws:
    
    PluginException - If the plugin could not be enabled
    
    Since:
    
    2.2.0
  - disable
```
public final void disable()
```
    Description copied from interface: Plugin
    
    Disables the plugin. Unless an exception is thrown, the plugin should be in the PluginState.DISABLED state. If the plugin is already in the PluginState.DISABLED state, nothing will happen.
    
    Specified by:
    
    disable in interface Plugin
  - disableInternal
```
protected void disableInternal()
                        throws PluginException
```
    Perform any internal disabling logic. Subclasses should only throw PluginException.
    
    Throws:
    
    PluginException - If the plugin could not be disabled
    
    Since:
    
    2.2.0
  - getRequiredPlugins
```
public Set<String> getRequiredPlugins()
```
  - getDependencies
```
@Nonnull
public PluginDependencies getDependencies()
```
    Description copied from interface: Plugin
    
    Determines which plugin keys are dependencies, categorising them as mandatory, optional or dynamic.
    
    Specified by:
    
    getDependencies in interface Plugin
    
    Returns:
    
    not null, possibly empty
  - getActivePermissions
```
public final Set<String> getActivePermissions()
```
    Specified by:
    
    getActivePermissions in interface Plugin
    
    Returns:
    
    the list of permissions currently valid for the plugin
  - hasAllPermissions
```
public final boolean hasAllPermissions()
```
    Specified by:
    
    hasAllPermissions in interface Plugin
    
    Returns:
    
    true if the plugin has all the permissions
  - getInstallationMode
```
public InstallationMode getInstallationMode()
```
    Description copied from interface: Plugin
    
    Gets the installation mode
    
    Specified by:
    
    getInstallationMode in interface Plugin
    
    Returns:
    
    the plugin's installation mode, local or remote.
  - close
```
public void close()
```
  - install
```
public final void install()
```
    Description copied from interface: Plugin
    
    Installs the plugin into any internal, managing container. This method will be called on every startup. Unless an exception is thrown, the plugin should be in the PluginState.INSTALLED state. If the plugin is already in the PluginState.INSTALLED state, nothing will happen.
    
    Specified by:
    
    install in interface Plugin
  - installInternal
```
protected void installInternal()
                        throws PluginException
```
    Perform any internal installation logic. Subclasses should only throw PluginException.
    
    Throws:
    
    PluginException - If the plugin could not be installed
    
    Since:
    
    2.2.0
  - uninstall
```
public final void uninstall()
```
    Description copied from interface: Plugin
    
    Uninstalls the plugin from any internal container. This method will be called on every shutdown. Unless an exception is thrown, the plugin should be in the PluginState.UNINSTALLED state. If the plugin is already in the PluginState.UNINSTALLED state, nothing will happen.
    
    Specified by:
    
    uninstall in interface Plugin
  - uninstallInternal
```
protected void uninstallInternal()
                          throws PluginException
```
    Perform any internal uninstallation logic. Subclasses should only throw PluginException.
    
    Throws:
    
    PluginException - If the plugin could not be uninstalled
    
    Since:
    
    2.2.0
  - isSystemPlugin
```
public boolean isSystemPlugin()
```
    Description copied from interface: Plugin
    
    Whether the plugin is a "system" plugin that shouldn't be made visible to the user.
    
    Specified by:
    
    isSystemPlugin in interface Plugin
    
    Returns:
    
    true if this plugin is a "system" plugin.
  - containsSystemModule
```
public boolean containsSystemModule()
```
    Specified by:
    
    containsSystemModule in interface Plugin
  - setSystemPlugin
```
public void setSystemPlugin(boolean system)
```
    Specified by:
    
    setSystemPlugin in interface Plugin
    
    Parameters:
    
    system - whether the plugin is a "system" plugin that shouldn't be made visible to the user.
  - resolve
```
public void resolve()
```
    Description copied from interface: Plugin
    
    Perform any required resolution. This is a hook to allow the plugin system to perform a resolution pass over a group of modules before the enable pass.
    
    Specified by:
    
    resolve in interface Plugin
  - getDateLoaded
```
public Date getDateLoaded()
```
    Description copied from interface: Plugin
    
    The date this plugin was loaded into the system.
    
    Specified by:
    
    getDateLoaded in interface Plugin
    
    Returns:
    
    The date this plugin was loaded into the system.
  - getDateInstalled
```
public Date getDateInstalled()
```
    Description copied from interface: Plugin
    
    The date this plugin was installed into the system, is the same as the loaded date for non artifact backed plugins
    
    Specified by:
    
    getDateInstalled in interface Plugin
    
    Returns:
    
    The date this plugin was installed into the system
  - getDateEnabling
```
@ExperimentalApi
public Date getDateEnabling()
```
    Description copied from interface: Plugin
    
    Obtain the date that the plugin system most recently commenced enabling this plugin. This may return null if the plugin has never commenced enabling, or if the value is unavailable for other reasons, such as wrappers around legacy implementations.
    
    Specified by:
    
    getDateEnabling in interface Plugin
    
    Returns:
    
    the date that the plugin most recently entered PluginState.ENABLING.
  - getDateEnabled
```
@ExperimentalApi
public Date getDateEnabled()
```
    Description copied from interface: Plugin
    
    Obtain the date that the plugin system most recently completed enabling of this plugin. This will return null if the plugin has never been enabled, has not completed enabling since it most recently started enabling, or if the value is unavailable for any other reason, such as wrappers around legacy implementations.
    
    Specified by:
    
    getDateEnabled in interface Plugin
    
    Returns:
    
    the date that the plugin most recently entered PluginState.ENABLED, if this was not before the most recent PluginState.ENABLING, otherwise null.
  - isBundledPlugin
```
public boolean isBundledPlugin()
```
    Description copied from interface: Plugin
    
    Whether the plugin is a "bundled" plugin that can't be removed.
    
    Specified by:
    
    isBundledPlugin in interface Plugin
    
    Returns:
    
    true if this plugin is a "bundled" plugin.
  - setBundledPlugin
```
public void setBundledPlugin(boolean bundledPlugin)
```
    Description copied from interface: PluginInternal
    
    Alters whether the plugin is a "bundled" plugin that can't be removed.
    
    Specified by:
    
    setBundledPlugin in interface PluginInternal
    
    Parameters:
    
    bundledPlugin - true if this plugin is a "bundled" plugin.
  - getPluginArtifact
```
public PluginArtifact getPluginArtifact()
```
    Description copied from interface: Plugin
    
    Retrieve the original, unprocessed or transformed PluginArtifact used to create this plugin instance.
    Note that this method may be removed without notice; it is for use only by the host application.
    This method was originally part of the internal PluginArtifactBackedPlugin interface that is no longer present.
    
    Specified by:
    
    getPluginArtifact in interface Plugin
    
    Returns:
    
    null if this plugin has no artifact
  - getScopeKey
```
public Optional<String> getScopeKey()
```
    Specified by:
    
    getScopeKey in interface ScopeAware
    
    Returns:
    
    scope set or Optional.empty() if not defined
  - getDynamicModuleDescriptors
```
public Iterable<ModuleDescriptor<?>> getDynamicModuleDescriptors()
```
    Specified by:
    
    getDynamicModuleDescriptors in interface PluginInternal
    
    Returns:
    
    current set of dynamic module descriptors.
  - addDynamicModuleDescriptor
```
public boolean addDynamicModuleDescriptor(ModuleDescriptor<?> module)
```
    Description copied from interface: PluginInternal
    
    Add a module descriptor.
    
    Specified by:
    
    addDynamicModuleDescriptor in interface PluginInternal
    
    Parameters:
    
    module - to add
    
    Returns:
    
    true if added, false if already present
  - removeDynamicModuleDescriptor
```
public boolean removeDynamicModuleDescriptor(ModuleDescriptor<?> module)
```
    Description copied from interface: PluginInternal
    
    Remove a module descriptor.
    
    Specified by:
    
    removeDynamicModuleDescriptor in interface PluginInternal
    
    Parameters:
    
    module - to remove
    
    Returns:
    
    true if removed, false if not present
  - compareTo
```
public int compareTo(@Nonnull
                     Plugin otherPlugin)
```
    Compares this Plugin to another Plugin for order. The primary sort field is the key, and the secondary field is the version number.
    
    Specified by:
    
    compareTo in interface Comparable<Plugin>
    
    Parameters:
    
    otherPlugin - The plugin to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this Plugin is less than, equal to, or greater than the specified Plugin.
    
    See Also:
    
    VersionStringComparator, Comparable.compareTo(T)
  - cleanVersionString
```
@Internal
public static String cleanVersionString(String version)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractPlugin

Field Summary

Fields inherited from interface com.atlassian.plugin.Plugin

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.plugin.Plugin

Field Detail

pluginArtifact

Constructor Detail

AbstractPlugin

Method Detail

getName

setName

getLog

getI18nNameKey

setI18nNameKey

getKey

setKey

addModuleDescriptor

removeModuleDescriptor

getModuleDescriptors

getModuleDescriptor

getModuleDescriptorsByModuleClass

getPluginState

setPluginState

compareAndSetPluginState

isEnabledByDefault

setEnabledByDefault

getPluginsVersion

setPluginsVersion

getPluginInformation

setPluginInformation

setResources

getResourceDescriptors

getResourceLocation

getResourceDescriptor

enable

enableInternal

disable

disableInternal

getRequiredPlugins

getDependencies

getActivePermissions

hasAllPermissions

getInstallationMode

close

install

installInternal

uninstall

uninstallInternal

isSystemPlugin

containsSystemModule

setSystemPlugin

resolve

getDateLoaded

getDateInstalled

getDateEnabling

getDateEnabled

isBundledPlugin

setBundledPlugin

getPluginArtifact

getScopeKey

getDynamicModuleDescriptors

addDynamicModuleDescriptor

removeDynamicModuleDescriptor

compareTo

cleanVersionString

toString