AbstractPlugin (Atlassian Plugins - Core 5.2.3-96cf760eb API)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultDynamicPlugin, 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()`
`protected void`	`disableInternal()` Perform any internal disabling logic.
`void`	`enable()`
`protected PluginState`	`enableInternal()` Perform any internal enabling logic.
`Set<String>`	`getActivePermissions()`
`Date`	`getDateEnabled()`
`Date`	`getDateEnabling()`
`Date`	`getDateInstalled()`
`Date`	`getDateLoaded()`
`PluginDependencies`	`getDependencies()`
`Iterable<ModuleDescriptor<?>>`	`getDynamicModuleDescriptors()`
`String`	`getI18nNameKey()`
`InstallationMode`	`getInstallationMode()`
`String`	`getKey()`
`protected org.slf4j.Logger`	`getLog()`
`ModuleDescriptor<?>`	`getModuleDescriptor(String key)`
`Collection<ModuleDescriptor<?>>`	`getModuleDescriptors()` Returns the module descriptors for this plugin
`<T> List<ModuleDescriptor<T>>`	`getModuleDescriptorsByModuleClass(Class<T> aClass)`
`String`	`getName()`
`PluginArtifact`	`getPluginArtifact()`
`PluginInformation`	`getPluginInformation()`
`PluginState`	`getPluginState()`
`int`	`getPluginsVersion()`
`Set<String>`	`getRequiredPlugins()`
`ResourceDescriptor`	`getResourceDescriptor(String type, String name)`
`List<ResourceDescriptor>`	`getResourceDescriptors()`
`ResourceLocation`	`getResourceLocation(String type, String name)`
`Optional<String>`	`getScopeKey()`
`boolean`	`hasAllPermissions()`
`void`	`install()`
`protected void`	`installInternal()` Perform any internal installation logic.
`boolean`	`isBundledPlugin()`
`boolean`	`isEnabledByDefault()`
`boolean`	`isSystemPlugin()`
`boolean`	`removeDynamicModuleDescriptor(ModuleDescriptor<?> module)` Remove a module descriptor.
`protected void`	`removeModuleDescriptor(String key)`
`void`	`resolve()`
`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)`
`void`	`setKey(String key)`
`void`	`setName(String name)`
`void`	`setPluginInformation(PluginInformation pluginInformation)`
`protected void`	`setPluginState(PluginState state)`
`void`	`setPluginsVersion(int pluginsVersion)`
`void`	`setResources(Resourced resources)`
`void`	`setSystemPlugin(boolean system)`
`String`	`toString()`
`void`	`uninstall()`
`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()
```
    Specified by:
    
    getName in interface Plugin
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface Plugin
  - getLog
```
protected org.slf4j.Logger getLog()
```
    Returns:
    
    the logger used internally
  - getI18nNameKey
```
public String getI18nNameKey()
```
    Specified by:
    
    getI18nNameKey in interface Plugin
  - setI18nNameKey
```
public void setI18nNameKey(String i18nNameKey)
```
    Specified by:
    
    setI18nNameKey in interface Plugin
  - 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)
```
    Specified by:
    
    getModuleDescriptor in interface Plugin
  - getModuleDescriptorsByModuleClass
```
public <T> List<ModuleDescriptor<T>> getModuleDescriptorsByModuleClass(Class<T> aClass)
```
    Specified by:
    
    getModuleDescriptorsByModuleClass in interface Plugin
  - getPluginState
```
public PluginState getPluginState()
```
    Specified by:
    
    getPluginState in interface 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()
```
    Specified by:
    
    getPluginsVersion in interface Plugin
  - setPluginsVersion
```
public void setPluginsVersion(int pluginsVersion)
```
    Specified by:
    
    setPluginsVersion in interface Plugin
  - 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()
```
    Specified by:
    
    getResourceDescriptors in interface Resourced
  - getResourceLocation
```
public ResourceLocation getResourceLocation(String type,
                                            String name)
```
    Specified by:
    
    getResourceLocation in interface Resourced
  - getResourceDescriptor
```
public ResourceDescriptor getResourceDescriptor(String type,
                                                String name)
```
    Specified by:
    
    getResourceDescriptor in interface Resourced
  - enable
```
public void enable()
```
    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()
```
    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()
```
    Specified by:
    
    getDependencies in interface Plugin
  - getActivePermissions
```
public final Set<String> getActivePermissions()
```
    Specified by:
    
    getActivePermissions in interface Plugin
  - hasAllPermissions
```
public final boolean hasAllPermissions()
```
    Specified by:
    
    hasAllPermissions in interface Plugin
  - getInstallationMode
```
public InstallationMode getInstallationMode()
```
    Specified by:
    
    getInstallationMode in interface Plugin
  - close
```
public void close()
```
  - install
```
public final void install()
```
    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()
```
    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()
```
    Specified by:
    
    isSystemPlugin in interface Plugin
  - containsSystemModule
```
public boolean containsSystemModule()
```
    Specified by:
    
    containsSystemModule in interface Plugin
  - setSystemPlugin
```
public void setSystemPlugin(boolean system)
```
    Specified by:
    
    setSystemPlugin in interface Plugin
  - resolve
```
public void resolve()
```
    Specified by:
    
    resolve in interface Plugin
  - getDateLoaded
```
public Date getDateLoaded()
```
    Specified by:
    
    getDateLoaded in interface Plugin
  - getDateInstalled
```
public Date getDateInstalled()
```
    Specified by:
    
    getDateInstalled in interface Plugin
  - getDateEnabling
```
@ExperimentalApi
public Date getDateEnabling()
```
    Specified by:
    
    getDateEnabling in interface Plugin
  - getDateEnabled
```
@ExperimentalApi
public Date getDateEnabled()
```
    Specified by:
    
    getDateEnabled in interface Plugin
  - isBundledPlugin
```
public boolean isBundledPlugin()
```
    Specified by:
    
    isBundledPlugin in interface 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()
```
    Specified by:
    
    getPluginArtifact in interface Plugin
  - getScopeKey
```
public Optional<String> getScopeKey()
```
    Specified by:
    
    getScopeKey in interface ScopeAware
  - 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