| Package | Description |
|---|---|
| com.atlassian.plugin | |
| com.atlassian.plugin.event.events |
This package contains events that will be fired by the framework.
|
| com.atlassian.plugin.factories | |
| com.atlassian.plugin.metadata | |
| com.atlassian.plugin.module | |
| com.atlassian.plugin.predicate |
| Modifier and Type | Class and Description |
|---|---|
class |
DummyPlugin
Dummy plugin implementation that returns java default values and does nothing.
|
| Modifier and Type | Method and Description |
|---|---|
static Plugin |
Permissions.addPermission(Plugin plugin,
String permission,
InstallationMode mode) |
Plugin |
PluginRegistry.ReadOnly.get(String key) |
Plugin |
PluginAccessor.getEnabledPlugin(String pluginKey)
Retrieve a given plugin if it is enabled.
|
Plugin |
ModuleDescriptor.getPlugin() |
Plugin |
PluginAccessor.getPlugin(String key)
Retrieve a given plugin (whether enabled or not).
|
Plugin |
PluginRegistry.ReadWrite.remove(String key) |
| Modifier and Type | Method and Description |
|---|---|
Collection<Plugin> |
PluginRegistry.ReadOnly.getAll() |
Collection<Plugin> |
PluginAccessor.getEnabledPlugins()
Get all of the currently enabled plugins.
|
Collection<Plugin> |
PluginAccessor.getPlugins()
Gets all of the currently installed plugins.
|
default Collection<Plugin> |
PluginAccessor.getPlugins(PluginPredicate pluginPredicate)
Deprecated.
in 5.0 for removal in 6.0, use
PluginAccessor.getPlugins(Predicate) instead |
Collection<Plugin> |
PluginAccessor.getPlugins(Predicate<Plugin> pluginPredicate)
Gets all installed plugins that match the given predicate.
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
PluginController.addDynamicModule(Plugin plugin,
org.dom4j.Element module)
Add a new module described by
element to the plugin specified. |
static Plugin |
Permissions.addPermission(Plugin plugin,
String permission,
InstallationMode mode) |
int |
DummyPlugin.compareTo(Plugin o) |
Iterable<ModuleDescriptor<?>> |
PluginAccessor.getDynamicModules(Plugin plugin)
Retrieve all currently registered dynamic modules i.e.
|
Map<String,PluginEnabledState> |
StoredPluginState.getPluginEnabledStateMap(Plugin plugin)
Get state map of the given plugin and its modules.
|
void |
ModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element)
Initialise a module given it's parent plugin and the XML element
representing the module.
|
boolean |
StoredPluginState.isEnabled(Plugin plugin)
Whether or not a plugin is enabled, calculated from its persisted state AND default state.
|
void |
PluginRegistry.ReadWrite.put(Plugin plugin) |
void |
PluginController.removeDynamicModule(Plugin plugin,
ModuleDescriptor<?> module)
Remove a module that was dynamically added to plugin..
|
void |
PluginController.uninstall(Plugin plugin)
Uninstall the plugin, disabling it first.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<Plugin> |
PluginAccessor.getPlugins(Predicate<Plugin> pluginPredicate)
Gets all installed plugins that match the given predicate.
|
default void |
PluginController.uninstallPlugins(Collection<Plugin> plugins)
Uninstall multiple plugin, disabling it first.
|
| Modifier and Type | Method and Description |
|---|---|
Plugin |
PluginEvent.getPlugin() |
| Modifier and Type | Method and Description |
|---|---|
List<Plugin> |
PluginDependentsChangedEvent.getCycled()
Plugins which had their state changed from enabled to disabled to enabled
|
List<Plugin> |
PluginDependentsChangedEvent.getDisabled()
Plugins which had their state changed from enabled to disabled
|
| Constructor and Description |
|---|
PluginDependentsChangedEvent(Plugin plugin,
PluginState state,
List<Plugin> disabled,
List<Plugin> cycled) |
PluginDisabledEvent(Plugin plugin) |
PluginDisablingEvent(Plugin plugin) |
PluginEnabledEvent(Plugin plugin) |
PluginEnablingEvent(Plugin plugin) |
PluginEvent(Plugin plugin) |
PluginInstalledEvent(Plugin plugin) |
PluginInstallingEvent(Plugin plugin) |
PluginRefreshedEvent(Plugin plugin) |
PluginUninstalledEvent(Plugin plugin) |
PluginUninstallingEvent(Plugin plugin) |
PluginUpgradedEvent(Plugin plugin) |
PluginUpgradingEvent(Plugin plugin) |
| Constructor and Description |
|---|
PluginDependentsChangedEvent(Plugin plugin,
PluginState state,
List<Plugin> disabled,
List<Plugin> cycled) |
PluginDependentsChangedEvent(Plugin plugin,
PluginState state,
List<Plugin> disabled,
List<Plugin> cycled) |
| Modifier and Type | Method and Description |
|---|---|
Plugin |
PluginFactory.create(PluginArtifact pluginArtifact,
ModuleDescriptorFactory moduleDescriptorFactory)
Deploys the plugin artifact by instantiating the plugin and configuring it.
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
PluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory)
If this factory is capable of loading a plugin of the type passed, attempt to create a module descriptor.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
PluginMetadataManager.isOptional(Plugin plugin)
This is used to determine if a plugin is considered optional.
|
boolean |
PluginMetadataManager.isSystemProvided(Plugin plugin)
This is used to determine if the plugin was provided by the host
application.
|
boolean |
PluginMetadataManager.isUserInstalled(Plugin plugin)
Determines if the plugin was installed by a user.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ContainerManagedPlugin
A plugin that is managed by a container
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
PluginPredicate.matches(Plugin plugin)
Deprecated.
Will match a plugin according to implementation rules.
|
Copyright © 2020 Atlassian. All rights reserved.