| Package | Description |
|---|---|
| com.atlassian.plugin | |
| com.atlassian.plugin.classloader | |
| com.atlassian.plugin.descriptors | |
| com.atlassian.plugin.event.events |
This package contains events that will be fired by the framework.
|
| com.atlassian.plugin.eventlistener.descriptors | |
| com.atlassian.plugin.exception | |
| com.atlassian.plugin.factories | |
| com.atlassian.plugin.impl | |
| com.atlassian.plugin.loaders | |
| com.atlassian.plugin.manager | |
| com.atlassian.plugin.metadata | |
| com.atlassian.plugin.module | |
| com.atlassian.plugin.osgi.bridge.external | |
| com.atlassian.plugin.osgi.factory |
Deployers for OSGi-related plugins
|
| com.atlassian.plugin.osgi.factory.descriptor | |
| com.atlassian.plugin.parsers | |
| com.atlassian.plugin.predicate | |
| com.atlassian.plugin.schema.impl | |
| com.atlassian.plugin.servlet | |
| com.atlassian.plugin.servlet.descriptors | |
| com.atlassian.plugin.util | |
| com.atlassian.plugin.util.collect | |
| com.atlassian.plugin.util.resource |
Classes having to do with resource loading, particularly from alternative locations.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
PluginInternal
Methods that are necessary for the plugin framework, however should not be exposed via public API.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DummyPlugin
Dummy plugin implementation that returns java default values and does nothing.
|
| Modifier and Type | Field and Description |
|---|---|
static Comparator<Plugin> |
Plugin.NAME_COMPARATOR
Deprecated.
since 2.2.0. This comparator only takes into account the plugin name and assumes it is not null,
yet a) that constraint is not validated anywhere in plugin loading and b) the plugin could have used the i18n
name, and only the application can resolve that to a name useful for comparisons.
|
| 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.
|
Collection<Plugin> |
PluginAccessor.getPlugins(PluginPredicate 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) |
void |
ModuleDescriptor.destroy(Plugin plugin)
Deprecated.
The plugin parameter is redundant. Override
ModuleDescriptor.destroy(). |
static Date |
Plugin.EnabledMetricsSource.Default.getDateEnabled(Plugin plugin)
Forwards to
getDateEnabled() |
static Date |
Plugin.EnabledMetricsSource.Default.getDateEnabling(Plugin plugin)
Forwards to
getDateEnabling() |
Iterable<ModuleDescriptor<?>> |
PluginAccessor.getDynamicModules(Plugin plugin)
Retrieve all currently registered dynamic modules i.e.
|
void |
ModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element)
Initialise a module given it's parent plugin and the XML element
representing the module.
|
void |
PluginRegistry.ReadWrite.put(Plugin plugin) |
void |
PluginController.removeDynamicModule(Plugin plugin,
ModuleDescriptor<?> module)
Remove a module that was dynamically added to plugin..
|
static void |
Plugin.Resolvable.Default.resolve(Plugin plugin)
Forwards to plugin.resolve().
|
void |
PluginController.uninstall(Plugin plugin)
Uninstall the plugin, disabling it first.
|
| Modifier and Type | Method and Description |
|---|---|
default void |
PluginController.uninstallPlugins(Collection<Plugin> plugins)
Uninstall multiple plugin, disabling it first.
|
| Modifier and Type | Method and Description |
|---|---|
Plugin |
PluginsClassLoader.getPluginForClass(String className)
Returns the Plugin that will be used to load the given class name.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PluginsClassLoader.notifyUninstallPlugin(Plugin plugin) |
| Modifier and Type | Field and Description |
|---|---|
protected Plugin |
AbstractModuleDescriptor.plugin |
| Modifier and Type | Method and Description |
|---|---|
Plugin |
AbstractModuleDescriptor.getPlugin() |
| Modifier and Type | Method and Description |
|---|---|
static UnloadableModuleDescriptor |
UnloadableModuleDescriptorFactory.createUnloadableModuleDescriptor(Plugin plugin,
org.dom4j.Element element,
Throwable e,
ModuleDescriptorFactory moduleDescriptorFactory)
Creates a new UnloadableModuleDescriptor, for when a problem occurs during the construction
of the ModuleDescriptor itself.
|
static UnloadableModuleDescriptor |
UnloadableModuleDescriptorFactory.createUnloadableModuleDescriptor(Plugin plugin,
ModuleDescriptor<?> descriptor,
Throwable e)
Creates a new UnloadableModuleDescriptor based on an existing ModuleDescriptor, descriptor
This method uses the information in an existing descriptor to construct a new UnloadableModuleDescriptor.
|
static UnrecognisedModuleDescriptor |
UnrecognisedModuleDescriptorFactory.createUnrecognisedModuleDescriptor(Plugin plugin,
org.dom4j.Element element,
Throwable e,
ModuleDescriptorFactory moduleDescriptorFactory)
Creates a new UnrecognisedModuleDescriptor, for when a problem occurs during the retrieval
of the ModuleDescriptor itself.
|
void |
AbstractModuleDescriptor.destroy(Plugin plugin)
Deprecated.
|
void |
AbstractModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
protected void |
AbstractModuleDescriptor.loadClass(Plugin plugin,
org.dom4j.Element element)
Deprecated.
Since 2.1.0, use
AbstractModuleDescriptor.loadClass(Plugin, String) instead |
protected void |
UnloadableModuleDescriptor.loadClass(Plugin plugin,
org.dom4j.Element element) |
protected void |
AbstractModuleDescriptor.loadClass(Plugin plugin,
String clazz)
Loads the module class that this descriptor provides, and will not
necessarily be the implementation class.
|
protected void |
UnloadableModuleDescriptor.loadClass(Plugin plugin,
String clazz) |
void |
AbstractModuleDescriptor.setPlugin(Plugin plugin)
Sets the plugin for the ModuleDescriptor
|
| Modifier and Type | Method and Description |
|---|---|
Plugin |
PluginEvent.getPlugin() |
| Modifier and Type | Method and Description |
|---|---|
Set<Plugin> |
PluginDependentsChangedEvent.getCycled()
Plugins which had their state changed from enabled to disabled to enabled
|
Set<Plugin> |
PluginDependentsChangedEvent.getDisabled()
Plugins which had their state changed from enabled to disabled
|
| Constructor and Description |
|---|
BeforePluginDisabledEvent(Plugin plugin)
Deprecated.
|
PluginDependentsChangedEvent(Plugin plugin,
PluginState state,
Set<Plugin> disabled,
Set<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,
Set<Plugin> disabled,
Set<Plugin> cycled) |
PluginDependentsChangedEvent(Plugin plugin,
PluginState state,
Set<Plugin> disabled,
Set<Plugin> cycled) |
| Modifier and Type | Method and Description |
|---|---|
void |
EventListenerModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
PluginExceptionInterception.onEnableException(Plugin plugin,
Exception pluginException)
This is called when a plugin cant be enabled because an exception has been thrown.
|
boolean |
NoOpPluginExceptionInterception.onEnableException(Plugin plugin,
Exception pluginException) |
| Modifier and Type | Method and Description |
|---|---|
Plugin |
AbstractPluginFactory.create(DeploymentUnit deploymentUnit,
ModuleDescriptorFactory moduleDescriptorFactory)
Deprecated.
|
Plugin |
PluginFactory.create(DeploymentUnit deploymentUnit,
ModuleDescriptorFactory moduleDescriptorFactory)
Deprecated.
Since 2.2.0, use
PluginFactory.create(PluginArtifact, ModuleDescriptorFactory) instead |
Plugin |
LegacyDynamicPluginFactory.create(PluginArtifact pluginArtifact,
ModuleDescriptorFactory moduleDescriptorFactory)
Deploys the plugin artifact
|
Plugin |
XmlDynamicPluginFactory.create(PluginArtifact pluginArtifact,
ModuleDescriptorFactory moduleDescriptorFactory)
Deploys the plugin artifact
|
Plugin |
PluginFactory.create(PluginArtifact pluginArtifact,
ModuleDescriptorFactory moduleDescriptorFactory)
Deploys the plugin artifact by instantiating the plugin and configuring it.
|
protected Plugin |
LegacyDynamicPluginFactory.createPlugin(DeploymentUnit deploymentUnit,
PluginClassLoader loader)
Deprecated.
Since 2.2.0, use
LegacyDynamicPluginFactory.createPlugin(PluginArtifact, PluginClassLoader) instead |
protected Plugin |
LegacyDynamicPluginFactory.createPlugin(PluginArtifact pluginArtifact,
PluginClassLoader loader)
Creates the plugin.
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
LegacyDynamicPluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
XmlDynamicPluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
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 | Class and Description |
|---|---|
class |
AbstractDelegatingPlugin
Deprecated.
since 4.0.0, to be removed in 5.0.0: No longer used
|
class |
AbstractPlugin
Represents the base class for all plugins.
|
class |
DefaultDynamicPlugin
A dynamically loaded plugin is loaded through the plugin class loader.
|
class |
StaticPlugin |
class |
UnloadablePlugin
This class represents a Plugin that was not able to be loaded by the PluginManager.
|
class |
XmlDynamicPlugin
A dynamic XML plugin that consists of the Atlassian plugin descriptor
|
| Modifier and Type | Method and Description |
|---|---|
Plugin |
AbstractDelegatingPlugin.getDelegate()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
int |
AbstractPlugin.compareTo(Plugin otherPlugin)
Compares this Plugin to another Plugin for order.
|
int |
AbstractDelegatingPlugin.compareTo(Plugin o)
Deprecated.
|
static UnloadablePlugin |
UnloadablePluginFactory.createUnloadablePlugin(Plugin oldPlugin)
Creates an UnloadablePlugin instance from a given plugin, when there were problems loading the modules or the plugin itself
|
static UnloadablePlugin |
UnloadablePluginFactory.createUnloadablePlugin(Plugin oldPlugin,
UnloadableModuleDescriptor unloadableDescriptor)
Creates an UnloadablePlugin instance from a given plugin.
|
| Constructor and Description |
|---|
AbstractDelegatingPlugin(Plugin delegate)
Deprecated.
|
| Modifier and Type | Field and Description |
|---|---|
protected Map<DeploymentUnit,Plugin> |
ScanningPluginLoader.plugins |
protected Collection<Plugin> |
SinglePluginLoader.plugins |
| Modifier and Type | Method and Description |
|---|---|
protected Plugin |
ScanningPluginLoader.deployPluginFromUnit(DeploymentUnit deploymentUnit,
ModuleDescriptorFactory moduleDescriptorFactory) |
protected Plugin |
SinglePluginLoader.loadPlugin(ModuleDescriptorFactory moduleDescriptorFactory) |
protected Plugin |
BundledPluginLoader.postProcess(Plugin plugin) |
protected Plugin |
ScanningPluginLoader.postProcess(Plugin plugin)
Template method that can be used by a specific
PluginLoader to
add information to a Plugin after it has been loaded. |
| Modifier and Type | Method and Description |
|---|---|
Iterable<Plugin> |
ForwardingPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
PluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Loads all plugins that can be installed in the plugin system.
|
Iterable<Plugin> |
ClassPathPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
ScanningPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
PermissionCheckingPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
SinglePluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
ForwardingPluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
PluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Load all newly found plugins that can be installed in the plugin system.
|
Iterable<Plugin> |
ClassPathPluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
ScanningPluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
PermissionCheckingPluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
Iterable<Plugin> |
SinglePluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory) |
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
ForwardingPluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
PluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory)
If this loader is capable of loading a plugin of the type passed, attempt to create a module descriptor.
|
ModuleDescriptor<?> |
ClassPathPluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
ScanningPluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
SinglePluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
void |
DiscardablePluginLoader.discardPlugin(Plugin plugin)
Notify the PluginLoader that the system will not be loading the given plugin.
|
void |
ForwardingPluginLoader.discardPlugin(Plugin plugin) |
void |
ScanningPluginLoader.discardPlugin(Plugin plugin) |
void |
PermissionCheckingPluginLoader.discardPlugin(Plugin plugin) |
protected Plugin |
BundledPluginLoader.postProcess(Plugin plugin) |
protected Plugin |
ScanningPluginLoader.postProcess(Plugin plugin)
Template method that can be used by a specific
PluginLoader to
add information to a Plugin after it has been loaded. |
void |
ForwardingPluginLoader.removePlugin(Plugin plugin) |
void |
PluginLoader.removePlugin(Plugin plugin)
Remove a specific plugin
|
void |
ClassPathPluginLoader.removePlugin(Plugin plugin) |
void |
ScanningPluginLoader.removePlugin(Plugin plugin) |
void |
PermissionCheckingPluginLoader.removePlugin(Plugin plugin) |
void |
SinglePluginLoader.removePlugin(Plugin plugin) |
| Modifier and Type | Method and Description |
|---|---|
Plugin |
PluginRegistryImpl.get(String pluginKey) |
Plugin |
DefaultPluginManager.getEnabledPlugin(String pluginKey) |
Plugin |
ProductPluginAccessorBase.getEnabledPlugin(String pluginKey) |
Plugin |
DefaultPluginManager.getPlugin(String key) |
Plugin |
ProductPluginAccessorBase.getPlugin(String key) |
Plugin |
PluginRegistryImpl.remove(String key) |
| Modifier and Type | Method and Description |
|---|---|
Collection<Plugin> |
PluginRegistryImpl.getAll() |
Collection<Plugin> |
DefaultPluginManager.getEnabledPlugins() |
Collection<Plugin> |
ProductPluginAccessorBase.getEnabledPlugins() |
Collection<Plugin> |
DefaultPluginManager.getPlugins() |
Collection<Plugin> |
ProductPluginAccessorBase.getPlugins() |
Collection<Plugin> |
DefaultPluginManager.getPlugins(PluginPredicate pluginPredicate) |
Collection<Plugin> |
ProductPluginAccessorBase.getPlugins(PluginPredicate pluginPredicate) |
Set<Plugin> |
PluginEnabler.getPluginsBeingEnabled() |
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
DefaultPluginManager.addDynamicModule(Plugin maybePluginInternal,
org.dom4j.Element module) |
protected void |
DefaultPluginManager.addPlugin(PluginLoader loader,
Plugin plugin)
Deprecated.
|
void |
PluginPersistentStateModifier.disable(Plugin plugin) |
protected void |
DefaultPluginManager.disablePluginState(Plugin plugin,
PluginPersistentStateStore stateStore)
Deprecated.
since 4.0, to be removed in 5.0
|
void |
PluginPersistentStateModifier.enable(Plugin plugin) |
protected void |
DefaultPluginManager.enablePluginState(Plugin plugin,
PluginPersistentStateStore stateStore)
Deprecated.
since 4.0, to be removed in 5.0
|
Iterable<ModuleDescriptor<?>> |
DefaultPluginManager.getDynamicModules(Plugin maybePluginInternal) |
Iterable<ModuleDescriptor<?>> |
ProductPluginAccessorBase.getDynamicModules(Plugin plugin) |
Map<String,PluginEnabledState> |
DefaultPluginPersistentState.getPluginEnabledStateMap(Plugin plugin) |
Map<String,PluginEnabledState> |
PluginPersistentState.getPluginEnabledStateMap(Plugin plugin)
Get state map of the given plugin and its modules.
|
default Map<String,Boolean> |
PluginPersistentState.getPluginStateMap(Plugin plugin)
Deprecated.
please use
PluginPersistentState.getPluginEnabledStateMap(Plugin) instead |
boolean |
DefaultPluginPersistentState.isEnabled(Plugin plugin) |
boolean |
PluginPersistentState.isEnabled(Plugin plugin)
Whether or not a plugin is enabled, calculated from it's current state AND default state.
|
boolean |
PluginEnabler.isPluginBeingEnabled(Plugin plugin) |
protected void |
DefaultPluginManager.notifyPluginDisabled(Plugin plugin)
Deprecated.
since 4.0.0. This is not a safe mechanism to intercept or access plugin disablement. This method will be removed
(or made private) in a future release. Interception should be done via
PluginDisablingEvent and
PluginDisabledEvent, and the public APIs DefaultPluginManager.disablePlugin(java.lang.String) or DefaultPluginManager.disablePluginWithoutPersisting(java.lang.String) should be
used for changing plugin state. |
protected void |
DefaultPluginManager.notifyPluginEnabled(Plugin plugin)
Deprecated.
since 4.0.0. This is not a safe mechanism to intercept or access plugin enablement. This method will be removed
(or made private) in a future release. Interception should be done via
PluginEnablingEvent and
PluginEnabledEvent, and the public API DefaultPluginManager.enablePlugins(java.lang.String...) should be used for changing plugin state. |
protected void |
DefaultPluginManager.notifyUninstallPlugin(Plugin plugin) |
boolean |
DefaultSafeModeManager.pluginShouldBeStarted(Plugin plugin,
Iterable<ModuleDescriptor> descriptors) |
boolean |
SafeModeManager.pluginShouldBeStarted(Plugin plugin,
Iterable<ModuleDescriptor> descriptors)
This checks if a plugin should be started when safe-mode is on
|
void |
PluginRegistryImpl.put(Plugin plugin) |
void |
DefaultPluginManager.removeDynamicModule(Plugin maybePluginInternal,
ModuleDescriptor<?> module) |
void |
PluginPersistentStateModifier.removeState(Plugin plugin) |
protected void |
DefaultPluginManager.removeStateFromStore(PluginPersistentStateStore stateStore,
Plugin plugin)
Deprecated.
since 4.0, to be removed in 5.0
|
void |
PluginPersistentStateModifier.setEnabled(Plugin plugin,
boolean enabled) |
PluginPersistentState.Builder |
PluginPersistentState.Builder.setEnabled(Plugin plugin,
boolean isEnabled) |
void |
DefaultPluginManager.uninstall(Plugin plugin)
Uninstalls the given plugin, emitting disabled and uninstalled events as it does so.
|
protected void |
DefaultPluginManager.uninstallNoEvent(Plugin plugin)
Preforms an uninstallation without broadcasting the uninstallation event.
|
protected void |
DefaultPluginManager.unloadPlugin(Plugin plugin)
Unload a plugin.
|
protected void |
DefaultPluginManager.updatePlugin(Plugin oldPlugin,
Plugin newPlugin)
Replace an already loaded plugin with another version.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
DefaultPluginManager.addPlugins(PluginLoader loader,
Collection<Plugin> pluginsToInstall)
Update the local plugin state and enable state aware modules.
|
void |
DefaultPluginManager.uninstallPlugins(Collection<Plugin> plugins) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
ClasspathFilePluginMetadata.applicationProvided(Plugin plugin) |
boolean |
DefaultPluginMetadataManager.isOptional(Plugin plugin)
A plugin is determined to be optional if the host application has not
indicated to the plugins system that it is required or if any of its
modules have been flagged as not optional.
|
boolean |
PluginMetadataManager.isOptional(Plugin plugin)
This is used to determine if a plugin is considered optional.
|
boolean |
DefaultPluginMetadataManager.isSystemProvided(Plugin plugin)
A plugin is determined to be "system" if
DefaultPluginMetadataManager.isUserInstalled(com.atlassian.plugin.Plugin) is false. |
boolean |
PluginMetadataManager.isSystemProvided(Plugin plugin)
This is used to determine if the plugin was provided by the host
application.
|
boolean |
DefaultPluginMetadataManager.isUserInstalled(Plugin plugin)
A plugin is determined to be non-user if
isBundledPlugin() is true or if the
host application has indicated to the plugins system that a plugin was
provided by it. |
boolean |
PluginMetadataManager.isUserInstalled(Plugin plugin)
Determines if the plugin was installed by a user.
|
boolean |
ClasspathFilePluginMetadata.required(Plugin plugin) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ContainerManagedPlugin
A plugin that is managed by a container
|
| Modifier and Type | Method and Description |
|---|---|
Plugin |
PluginRetrievalService.getPlugin() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
OsgiBackedPlugin
Interface for plugins backed by OSGi
Bundle |
| Modifier and Type | Class and Description |
|---|---|
class |
OsgiBundlePlugin
Plugin that wraps an OSGi bundle
|
class |
OsgiPlugin
Plugin that wraps an OSGi bundle that does contain a plugin descriptor.
|
| Modifier and Type | Method and Description |
|---|---|
Plugin |
UnloadableStaticPluginFactory.create(PluginArtifact pluginArtifact,
ModuleDescriptorFactory moduleDescriptorFactory)
Creates an unloadable plugin
|
Plugin |
OsgiPluginFactory.create(PluginArtifact pluginArtifact,
ModuleDescriptorFactory moduleDescriptorFactory)
Deploys the plugin artifact.
|
Plugin |
OsgiBundleFactory.create(PluginArtifact pluginArtifact,
ModuleDescriptorFactory moduleDescriptorFactory)
Create a plugin from the given artifact.
|
Plugin |
RemotablePluginFactory.create(PluginArtifact pluginArtifact,
ModuleDescriptorFactory moduleDescriptorFactory)
Creates the plugin
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
OsgiPluginXmlDescriptorParser.addModule(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin,
org.dom4j.Element module)
Passes module descriptor elements back to the
OsgiPlugin |
ModuleDescriptor<?> |
UnloadableStaticPluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
OsgiPluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
OsgiBundleFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
RemotablePluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
protected ModuleDescriptor<?> |
OsgiPluginXmlDescriptorParser.createModuleDescriptor(Plugin plugin,
org.dom4j.Element element,
ModuleDescriptorFactory moduleDescriptorFactory)
Passes module descriptor elements back to the
OsgiPlugin |
| Modifier and Type | Method and Description |
|---|---|
void |
ComponentModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
void |
ComponentImportModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
protected void |
ComponentModuleDescriptor.loadClass(Plugin plugin,
String clazz) |
| Modifier and Type | Method and Description |
|---|---|
Plugin |
XmlDescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin) |
Plugin |
DescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin)
Sets the configuration on the plugin argument to match the configuration specified in the
plugin descriptor (typically an XML file).
|
| Modifier and Type | Method and Description |
|---|---|
static ModuleDescriptor<?> |
XmlDescriptorParserUtils.addModule(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin,
org.dom4j.Element module) |
ModuleDescriptor<?> |
XmlDescriptorParser.addModule(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin,
org.dom4j.Element module) |
ModuleDescriptor<?> |
DescriptorParser.addModule(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin,
org.dom4j.Element module)
Create a new module and initialise it with the plugin, then return it.
|
Plugin |
XmlDescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin) |
Plugin |
DescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin)
Sets the configuration on the plugin argument to match the configuration specified in the
plugin descriptor (typically an XML file).
|
protected ModuleDescriptor<?> |
XmlDescriptorParser.createModuleDescriptor(Plugin plugin,
org.dom4j.Element element,
ModuleDescriptorFactory moduleDescriptorFactory) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
EnabledPluginPredicate.matches(Plugin plugin) |
boolean |
PluginKeyPatternsPredicate.matches(Plugin plugin) |
boolean |
PluginPredicate.matches(Plugin plugin)
Will match a plugin according to implementation rules.
|
| Constructor and Description |
|---|
EnabledPluginPredicate(Set<Plugin> pluginsBeingEnabled) |
| Modifier and Type | Method and Description |
|---|---|
void |
DescribedModuleTypeModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultServletModuleManager.addServlet(Plugin plugin,
String servletName,
javax.servlet.http.HttpServlet servlet,
javax.servlet.ServletContext servletContext) |
void |
ServletModuleManager.addServlet(Plugin plugin,
String servletName,
javax.servlet.http.HttpServlet servlet,
javax.servlet.ServletContext servletContext)
To be invoked by
PluginServletContextWrapper.addServlet(String, javax.servlet.Servlet). |
void |
DefaultServletModuleManager.addServlet(Plugin plugin,
String servletName,
String className) |
void |
ServletModuleManager.addServlet(Plugin plugin,
String servletName,
String className)
|
| Constructor and Description |
|---|
DownloadableClasspathResource(Plugin plugin,
ResourceLocation resourceLocation,
String extraPath) |
DownloadableWebResource(Plugin plugin,
ResourceLocation resourceLocation,
String extraPath,
javax.servlet.ServletContext servletContext,
boolean disableMinification) |
EmptyDownloadableResource(Plugin plugin,
ResourceLocation resourceLocation) |
PluginServletContextWrapper(ServletModuleManager servletModuleManager,
Plugin plugin,
javax.servlet.ServletContext context,
ConcurrentMap<String,Object> attributes,
Map<String,String> initParams) |
| Modifier and Type | Method and Description |
|---|---|
void |
ServletContextParamModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
void |
ServletFilterModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
void |
ServletContextListenerModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
void |
BaseServletModuleDescriptor.init(Plugin plugin,
org.dom4j.Element element) |
| Modifier and Type | Method and Description |
|---|---|
static boolean |
PluginUtils.doesPluginRequireRestart(Plugin plugin)
Determines if a plugin requires a restart after being installed at runtime.
|
static Set<String> |
PluginUtils.getPluginModulesThatRequireRestart(Plugin plugin)
Gets a list of all the module keys in a plugin that require restart.
|
| Modifier and Type | Method and Description |
|---|---|
static Iterable<String> |
Transforms.toPluginKeys(Iterable<Plugin> plugins) |
| Constructor and Description |
|---|
AlternativePluginResourceLoader(Plugin plugin) |
Copyright © 2018 Atlassian. All rights reserved.