A B C D E F G H I J L M N O P R S T U V W

A

addDynamicModule(Plugin, Element) - Method in interface com.atlassian.plugin.PluginController

Add a new module described by element to the plugin specified.

addModuleDescriptor(ModuleDescriptor<?>) - Method in class com.atlassian.plugin.DummyPlugin

addModuleDescriptor(ModuleDescriptor<?>) - Method in interface com.atlassian.plugin.Plugin

addParameter(String, String) - Method in class com.atlassian.plugin.PluginInformation

addPermission(Plugin, String, InstallationMode) - Static method in class com.atlassian.plugin.Permissions

ALL - Static variable in class com.atlassian.plugin.PluginPermission

ALL_PERMISSIONS - Static variable in class com.atlassian.plugin.Permissions

Represents all the permissions in one.

allowsReference() - Method in interface com.atlassian.plugin.PluginArtifact.AllowsReference

Deprecated.

allowsReference(PluginArtifact) - Static method in class com.atlassian.plugin.PluginArtifact.AllowsReference.Default

Deprecated.

Forwards to PluginArtifact.getReferenceMode() and ReferenceMode.allowsReference.

allowsReference() - Method in enum com.atlassian.plugin.ReferenceMode

Application - Interface in com.atlassian.plugin

This represents the application that uses the plugin system.

apply(ResourceDescriptor) - Method in class com.atlassian.plugin.Resources.TypeFilter

Assertions - Class in com.atlassian.plugin.util

Design by contract assertions.

B

BeforePluginDisabledEvent - Class in com.atlassian.plugin.event.events

Deprecated.

since 4.0.0. Use PluginDisablingEvent instead.

BeforePluginDisabledEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.BeforePluginDisabledEvent

Deprecated.

BeforePluginModuleDisabledEvent - Class in com.atlassian.plugin.event.events

Deprecated.

since 4.0.0. Use PluginModuleDisablingEvent instead.

BeforePluginModuleDisabledEvent(ModuleDescriptor<?>, boolean) - Constructor for class com.atlassian.plugin.event.events.BeforePluginModuleDisabledEvent

Deprecated.

broadcast(Object) - Method in interface com.atlassian.plugin.event.PluginEventManager

Broadcasts an event to all applicable listeners.

build() - Method in class com.atlassian.plugin.PluginDependencies.Builder

builder() - Static method in class com.atlassian.plugin.PluginDependencies

C

canCreate(PluginArtifact) - Method in interface com.atlassian.plugin.factories.PluginFactory

Determines if this factory can handle this artifact.

clear() - Method in interface com.atlassian.plugin.PluginRegistry.ReadWrite

close() - Method in class com.atlassian.plugin.DummyPlugin

close() - Method in interface com.atlassian.plugin.Plugin

Deprecated.

Since 2.2.0, use Plugin.uninstall() instead

com.atlassian.plugin - package com.atlassian.plugin

com.atlassian.plugin.elements - package com.atlassian.plugin.elements

com.atlassian.plugin.event - package com.atlassian.plugin.event

com.atlassian.plugin.event.events - package com.atlassian.plugin.event.events

This package contains events that will be fired by the framework.

com.atlassian.plugin.factories - package com.atlassian.plugin.factories

com.atlassian.plugin.hostcontainer - package com.atlassian.plugin.hostcontainer

com.atlassian.plugin.loaders - package com.atlassian.plugin.loaders

com.atlassian.plugin.loaders.classloading - package com.atlassian.plugin.loaders.classloading

com.atlassian.plugin.module - package com.atlassian.plugin.module

com.atlassian.plugin.predicate - package com.atlassian.plugin.predicate

com.atlassian.plugin.scope - package com.atlassian.plugin.scope

com.atlassian.plugin.util - package com.atlassian.plugin.util

compareTo(Plugin) - Method in class com.atlassian.plugin.DummyPlugin

compareTo(DeploymentUnit) - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit

ContainerAccessor - Interface in com.atlassian.plugin.module

The ContainerAccessor allows access to the underlying plugin container (e.g.

ContainerManagedPlugin - Interface in com.atlassian.plugin.module

A plugin that is managed by a container

containsJavaExecutableCode() - Method in interface com.atlassian.plugin.PluginArtifact

containsSpringContext() - Method in interface com.atlassian.plugin.PluginArtifact

containsSystemModule() - Method in class com.atlassian.plugin.DummyPlugin

containsSystemModule() - Method in interface com.atlassian.plugin.Plugin

create(DeploymentUnit, ModuleDescriptorFactory) - Method in interface com.atlassian.plugin.factories.PluginFactory

Deprecated.

Since 2.2.0, use PluginFactory.create(PluginArtifact, ModuleDescriptorFactory) instead

create(PluginArtifact, ModuleDescriptorFactory) - Method in interface com.atlassian.plugin.factories.PluginFactory

Deploys the plugin artifact by instantiating the plugin and configuring it.

create(Class<T>) - Method in interface com.atlassian.plugin.hostcontainer.HostContainer

Constructs an instance of a class, matching the constructor with the largest number of arguments first, and autowires as appropriate.

CREATE_SYSTEM_MODULES - Static variable in class com.atlassian.plugin.Permissions

A permission to create system modules.

createBean(Class<T>) - Method in interface com.atlassian.plugin.module.ContainerAccessor

Will ask the container to instantiate a bean of the given class and does inject all constructor defined dependencies.

createModule(Plugin, Element, ModuleDescriptorFactory) - Method in interface com.atlassian.plugin.factories.PluginFactory

If this factory is capable of loading a plugin of the type passed, attempt to create a module descriptor.

createModule(String, ModuleDescriptor<T>) - Method in class com.atlassian.plugin.module.LegacyModuleFactory

createModule(String, ModuleDescriptor<T>) - Method in interface com.atlassian.plugin.module.ModuleFactory

Creates the module instance.

D

Default() - Constructor for class com.atlassian.plugin.Plugin.EnabledMetricsSource.Default

Deprecated.

Default() - Constructor for class com.atlassian.plugin.Plugin.Resolvable.Default

Deprecated.

Default() - Constructor for class com.atlassian.plugin.PluginArtifact.AllowsReference.Default

Deprecated.

DeploymentUnit - Class in com.atlassian.plugin.loaders.classloading

A file that is to, or has been, deployed as a plugin.

DeploymentUnit(File) - Constructor for class com.atlassian.plugin.loaders.classloading.DeploymentUnit

destroy(Plugin) - Method in interface com.atlassian.plugin.ModuleDescriptor

Deprecated.

The plugin parameter is redundant. Override ModuleDescriptor.destroy().

destroy() - Method in interface com.atlassian.plugin.ModuleDescriptor

Override this if your plugin needs to clean up when it's been removed.

disable() - Method in class com.atlassian.plugin.DummyPlugin

disable() - Method in interface com.atlassian.plugin.Plugin

Disables the plugin.

disabled() - Method in interface com.atlassian.plugin.StateAware

Called by the plugin manager when the plugin or module is deactivated.

disablePlugin(String) - Method in interface com.atlassian.plugin.PluginController

Disables the plugin with the given key.

disablePluginModule(String) - Method in interface com.atlassian.plugin.PluginController

Disable a plugin module by key.

disablePluginWithoutPersisting(String) - Method in interface com.atlassian.plugin.PluginController

Disables the plugin with the given key without persisting the disabled state.

doesResourceExist(String) - Method in interface com.atlassian.plugin.PluginArtifact

doesTypeAndNameMatch(String, String) - Method in class com.atlassian.plugin.elements.ResourceDescriptor

DummyPlugin - Class in com.atlassian.plugin

Dummy plugin implementation that returns java default values and does nothing.

DummyPlugin() - Constructor for class com.atlassian.plugin.DummyPlugin

E

EMPTY_RESOURCES - Static variable in class com.atlassian.plugin.Resources

enable() - Method in class com.atlassian.plugin.DummyPlugin

enable() - Method in interface com.atlassian.plugin.Plugin

Enables the plugin.

enabled() - Method in interface com.atlassian.plugin.StateAware

Called by the plugin manager when a plugin or module is activated.

enablePlugin(String) - Method in interface com.atlassian.plugin.PluginController

Deprecated.

since 2.5.0, use {#link enablePlugins(String... keys)} instead

enablePluginModule(String) - Method in interface com.atlassian.plugin.PluginController

Enable a plugin module by key.

enablePlugins(String...) - Method in interface com.atlassian.plugin.PluginController

Enable a set of plugins by key.

equals(Object) - Method in class com.atlassian.plugin.elements.ResourceDescriptor

equals(Object) - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit

equals(DeploymentUnit) - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit

equals(Object) - Method in class com.atlassian.plugin.ModuleCompleteKey

equals(Object) - Method in interface com.atlassian.plugin.ModuleDescriptor

Compares the specified object with this module descriptor for equality.

equals(Object) - Method in class com.atlassian.plugin.PluginPermission

EXECUTE_JAVA - Static variable in class com.atlassian.plugin.Permissions

A permission to execute java code.

EXECUTE_JAVA - Static variable in class com.atlassian.plugin.PluginPermission

extraModuleDescriptorFiles(String) - Method in interface com.atlassian.plugin.PluginArtifact.HasExtraModuleDescriptors

F

FILENAME - Static variable in class com.atlassian.plugin.PluginAccessor.Descriptor

The default filename.

fromXml(Element) - Static method in class com.atlassian.plugin.Resources

Parses the resource descriptors from the provided plugin XML element and creates a Resources object containing them.

G

GENERATE_ANY_HTML - Static variable in class com.atlassian.plugin.Permissions

A permission to generate arbitrary HTML.

get(String) - Method in interface com.atlassian.plugin.PluginRegistry.ReadOnly

getActiveModuleDescriptorsByClass(Class<D>) - Method in interface com.atlassian.plugin.PluginAccessor

Get all enabled module descriptors that have a specific descriptor class and are considered active for the current request.

getActivePermissions() - Method in class com.atlassian.plugin.DummyPlugin

getActivePermissions() - Method in interface com.atlassian.plugin.Plugin

getAll() - Method in class com.atlassian.plugin.PluginDependencies

getAll() - Method in interface com.atlassian.plugin.PluginRegistry.ReadOnly

getAllCauses() - Method in exception com.atlassian.plugin.event.NotificationException

getBean(String) - Method in interface com.atlassian.plugin.module.ContainerAccessor

Retrieves a bean by name from the container.

getBeansOfType(Class<T>) - Method in interface com.atlassian.plugin.module.ContainerAccessor

Gets all the beans that implement a given interface

getBuildNumber() - Method in interface com.atlassian.plugin.Application

The build number of the application, as a string.

getByPluginKey() - Method in class com.atlassian.plugin.PluginDependencies

getCause() - Method in class com.atlassian.plugin.event.events.PluginContainerFailedEvent

getClassLoader() - Method in class com.atlassian.plugin.DummyPlugin

getClassLoader() - Method in interface com.atlassian.plugin.Plugin

Get the classloader for the plugin.

getClassLoader() - Method in interface com.atlassian.plugin.PluginAccessor

Retrieve the class loader responsible for loading classes and resources from plugins.

getClassName() - Method in exception com.atlassian.plugin.module.ModuleClassNotFoundException

getCompleteKey() - Method in class com.atlassian.plugin.ModuleCompleteKey

Returns the String representation of the complete key.

getCompleteKey() - Method in interface com.atlassian.plugin.ModuleDescriptor

The complete key for this module, including the plugin key.

getContainer() - Method in class com.atlassian.plugin.event.events.PluginContainerFailedEvent

getContainer() - Method in class com.atlassian.plugin.event.events.PluginContainerRefreshedEvent

getContainerAccessor() - Method in interface com.atlassian.plugin.module.ContainerManagedPlugin

getContent() - Method in class com.atlassian.plugin.elements.ResourceDescriptor

getContent() - Method in class com.atlassian.plugin.elements.ResourceLocation

getContentType() - Method in class com.atlassian.plugin.elements.ResourceLocation

getCycled() - Method in class com.atlassian.plugin.event.events.PluginDependentsChangedEvent

Plugins which had their state changed from enabled to disabled to enabled

getDateEnabled() - Method in class com.atlassian.plugin.DummyPlugin

getDateEnabled(Plugin) - Static method in class com.atlassian.plugin.Plugin.EnabledMetricsSource.Default

Deprecated.

Forwards to Plugin.getDateEnabled()

getDateEnabled() - Method in interface com.atlassian.plugin.Plugin.EnabledMetricsSource

Deprecated.

getDateEnabled() - Method in interface com.atlassian.plugin.Plugin

Obtain the date that the plugin system most recently completed enabling of this plugin.

getDateEnabling() - Method in class com.atlassian.plugin.DummyPlugin

getDateEnabling(Plugin) - Static method in class com.atlassian.plugin.Plugin.EnabledMetricsSource.Default

Deprecated.

Forwards to Plugin.getDateEnabling()

getDateEnabling() - Method in interface com.atlassian.plugin.Plugin.EnabledMetricsSource

Deprecated.

getDateEnabling() - Method in interface com.atlassian.plugin.Plugin

Obtain the date that the plugin system most recently commenced enabling this plugin.

getDateInstalled() - Method in class com.atlassian.plugin.DummyPlugin

getDateInstalled() - Method in interface com.atlassian.plugin.Plugin

The date this plugin was installed into the system, is the same as the loaded date for non artifact backed plugins

getDateLoaded() - Method in class com.atlassian.plugin.DummyPlugin

getDateLoaded() - Method in interface com.atlassian.plugin.Plugin

The date this plugin was loaded into the system.

getDependencies() - Method in class com.atlassian.plugin.DummyPlugin

getDependencies() - Method in interface com.atlassian.plugin.Plugin

Determines which plugin keys are dependencies, categorising them as mandatory, optional or dynamic.

getDescription() - Method in interface com.atlassian.plugin.ModuleDescriptor

A simple description of this descriptor.

getDescription() - Method in class com.atlassian.plugin.PluginInformation

getDescriptionKey() - Method in interface com.atlassian.plugin.ModuleDescriptor

Key used to override ModuleDescriptor.getDescription() when using internationalisation.

getDescriptionKey() - Method in class com.atlassian.plugin.PluginInformation

getDisabled() - Method in class com.atlassian.plugin.event.events.PluginDependentsChangedEvent

Plugins which had their state changed from enabled to disabled

getDynamic() - Method in class com.atlassian.plugin.PluginDependencies

getDynamicModules(Plugin) - Method in interface com.atlassian.plugin.PluginAccessor

Retrieve all currently registered dynamic modules i.e.

getDynamicPluginClass(String) - Method in interface com.atlassian.plugin.PluginAccessor

Deprecated.

since 0.21 this method is not used, use PluginAccessor.getPlugin(String).getClassLoader().loadClass(String)

getDynamicResourceAsStream(String) - Method in interface com.atlassian.plugin.PluginAccessor

Retrieve a resource from a currently loaded (and active) dynamically loaded plugin.

getEnabledModuleDescriptorsByClass(Class<D>) - Method in interface com.atlassian.plugin.PluginAccessor

Get all enabled module descriptors that have a specific descriptor class.

getEnabledModuleDescriptorsByClass(Class<D>, boolean) - Method in interface com.atlassian.plugin.PluginAccessor

Deprecated.

Since 2.3.0, use #getEnabledModuleDescriptorsByClass(Class) instead

getEnabledModuleDescriptorsByType(String) - Method in interface com.atlassian.plugin.PluginAccessor

Deprecated.

since 0.17, use PluginAccessor.getModuleDescriptors(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.

getEnabledModulesByClass(Class<M>) - Method in interface com.atlassian.plugin.PluginAccessor

Retrieve all plugin modules that implement or extend a specific class.

getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>>[], Class<M>) - Method in interface com.atlassian.plugin.PluginAccessor

Deprecated.

since 0.17, use PluginAccessor.getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.

getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>>, Class<M>) - Method in interface com.atlassian.plugin.PluginAccessor

Deprecated.

since 0.17, use PluginAccessor.getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.

getEnabledPlugin(String) - Method in interface com.atlassian.plugin.PluginAccessor

Retrieve a given plugin if it is enabled.

getEnabledPluginModule(String) - Method in interface com.atlassian.plugin.PluginAccessor

Retrieve an enabled plugin module by complete module key.

getEnabledPlugins() - Method in interface com.atlassian.plugin.PluginAccessor

Get all of the currently enabled plugins.

getI18nNameKey() - Method in class com.atlassian.plugin.DummyPlugin

getI18nNameKey() - Method in interface com.atlassian.plugin.ModuleDescriptor

Key used to override ModuleDescriptor.getName() when using internationalisation.

getI18nNameKey() - Method in interface com.atlassian.plugin.Plugin

Returns the i18nKey used to get an internationalised name for this plugin.

getInputStream() - Method in interface com.atlassian.plugin.PluginArtifact

getInstallationMode() - Method in class com.atlassian.plugin.DummyPlugin

getInstallationMode() - Method in interface com.atlassian.plugin.Plugin

Gets the installation mode

getInstallationMode() - Method in class com.atlassian.plugin.PluginPermission

The installation mode for that permission.

getKey() - Method in interface com.atlassian.plugin.Application

The application key, e.g.

getKey() - Method in class com.atlassian.plugin.DummyPlugin

getKey() - Method in enum com.atlassian.plugin.InstallationMode

getKey() - Method in interface com.atlassian.plugin.ModuleDescriptor

The key for this module, unique within the plugin.

getKey() - Method in interface com.atlassian.plugin.Plugin

getLocation() - Method in class com.atlassian.plugin.elements.ResourceDescriptor

getLocation() - Method in class com.atlassian.plugin.elements.ResourceLocation

getMandatory() - Method in class com.atlassian.plugin.PluginDependencies

getMaxVersion() - Method in class com.atlassian.plugin.PluginInformation

Deprecated.

Since 2.2.0

getMessage() - Method in exception com.atlassian.plugin.module.ModuleClassNotFoundException

getMinJavaVersion() - Method in interface com.atlassian.plugin.ModuleDescriptor

getMinJavaVersion() - Method in class com.atlassian.plugin.PluginInformation

getMinVersion() - Method in class com.atlassian.plugin.PluginInformation

Deprecated.

Since 2.2.0

getModule() - Method in class com.atlassian.plugin.event.events.PluginModuleEvent

getModule() - Method in interface com.atlassian.plugin.ModuleDescriptor

The particular module object created by this plugin.

getModuleClass(String, ModuleDescriptor<T>) - Method in class com.atlassian.plugin.module.LegacyModuleFactory

getModuleClass() - Method in interface com.atlassian.plugin.ModuleDescriptor

The class of the module this descriptor creates.

getModuleDescriptor(String) - Method in class com.atlassian.plugin.DummyPlugin

getModuleDescriptor(String) - Method in interface com.atlassian.plugin.ModuleDescriptorFactory

getModuleDescriptor(String) - Method in interface com.atlassian.plugin.Plugin

Get the ModuleDescriptor for a particular key.

getModuleDescriptorClass(String) - Method in interface com.atlassian.plugin.ModuleDescriptorFactory

getModuleDescriptors() - Method in class com.atlassian.plugin.DummyPlugin

getModuleDescriptors() - Method in interface com.atlassian.plugin.Plugin

Get the Collection of descriptors.

getModuleDescriptors(ModuleDescriptorPredicate<M>) - Method in interface com.atlassian.plugin.PluginAccessor

Gets all module descriptors of installed modules that match the given predicate.

getModuleDescriptorsByModuleClass(Class<M>) - Method in class com.atlassian.plugin.DummyPlugin

getModuleDescriptorsByModuleClass(Class<M>) - Method in interface com.atlassian.plugin.Plugin

Get the descriptors whose module class implements or is assignable from the supplied Class.

getModuleKey() - Method in exception com.atlassian.plugin.module.ModuleClassNotFoundException

getModuleKey() - Method in class com.atlassian.plugin.ModuleCompleteKey

Returns the "simple" module key.

getModules(ModuleDescriptorPredicate<M>) - Method in interface com.atlassian.plugin.PluginAccessor

Gets all installed modules that match the given predicate.

getModuleScanFolders() - Method in class com.atlassian.plugin.PluginInformation

getName() - Method in class com.atlassian.plugin.DummyPlugin

getName() - Method in class com.atlassian.plugin.elements.ResourceDescriptor

This may throw an exception if one of the deprecated methods is used on a ResourceDescriptor which has been given a namePattern

getName() - Method in class com.atlassian.plugin.elements.ResourceLocation

getName() - Method in interface com.atlassian.plugin.ModuleDescriptor

A simple string name for this descriptor.

getName() - Method in interface com.atlassian.plugin.Plugin

Returns the non-localised name of this plugin if defined.

getName() - Method in interface com.atlassian.plugin.PluginArtifact

getName() - Method in class com.atlassian.plugin.PluginPermission

getOptional() - Method in class com.atlassian.plugin.PluginDependencies

getParameter(String) - Method in class com.atlassian.plugin.elements.ResourceDescriptor

getParameter(String) - Method in class com.atlassian.plugin.elements.ResourceLocation

getParameters() - Method in class com.atlassian.plugin.elements.ResourceDescriptor

getParameters() - Method in class com.atlassian.plugin.PluginInformation

getParams() - Method in class com.atlassian.plugin.elements.ResourceLocation

getParams(Element) - Static method in class com.atlassian.plugin.loaders.LoaderUtils

getParams() - Method in interface com.atlassian.plugin.ModuleDescriptor

getPath() - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit

getPermissions() - Method in class com.atlassian.plugin.PluginInformation

The set of permissions that the plugin requires to run.

getPlugin() - Method in class com.atlassian.plugin.event.events.PluginEvent

getPlugin() - Method in interface com.atlassian.plugin.ModuleDescriptor

getPlugin(String) - Method in interface com.atlassian.plugin.PluginAccessor

Retrieve a given plugin (whether enabled or not).

getPluginAccessor() - Method in class com.atlassian.plugin.event.events.PluginFrameworkEvent

getPluginArtifact() - Method in class com.atlassian.plugin.DummyPlugin

getPluginArtifact() - Method in interface com.atlassian.plugin.Plugin

Retrieve the original, unprocessed or transformed PluginArtifact used to create this plugin instance.

getPluginController() - Method in class com.atlassian.plugin.event.events.PluginFrameworkEvent

getPluginInformation() - Method in class com.atlassian.plugin.DummyPlugin

getPluginInformation() - Method in interface com.atlassian.plugin.Plugin

getPluginKey() - Method in class com.atlassian.plugin.event.events.PluginContainerFailedEvent

getPluginKey() - Method in class com.atlassian.plugin.event.events.PluginContainerRefreshedEvent

getPluginKey() - Method in class com.atlassian.plugin.event.events.PluginContainerUnavailableEvent

getPluginKey() - Method in exception com.atlassian.plugin.module.ModuleClassNotFoundException

getPluginKey() - Method in class com.atlassian.plugin.ModuleCompleteKey

Returns the plugin key.

getPluginKey() - Method in interface com.atlassian.plugin.ModuleDescriptor

The plugin key for this module, derived from the complete key.

getPluginModule(String) - Method in interface com.atlassian.plugin.PluginAccessor

Retrieve any plugin module by complete module key.

getPluginResourceAsStream(String, String) - Method in interface com.atlassian.plugin.PluginAccessor

Deprecated.

since 0.21 this method is not used, use PluginAccessor.getPlugin(String).getClassLoader().getResourceAsStream(String)

getPluginRestartState(String) - Method in interface com.atlassian.plugin.PluginAccessor

Gets the state of the plugin upon restart.

getPlugins() - Method in interface com.atlassian.plugin.PluginAccessor

Gets all of the currently installed plugins.

getPlugins(PluginPredicate) - Method in interface com.atlassian.plugin.PluginAccessor

Gets all installed plugins that match the given predicate.

getPluginState() - Method in class com.atlassian.plugin.DummyPlugin

getPluginState() - Method in interface com.atlassian.plugin.Plugin

Returns this plugin's current state.

getPluginsVersion() - Method in class com.atlassian.plugin.DummyPlugin

getPluginsVersion() - Method in interface com.atlassian.plugin.Plugin

Gets the version of the plugins system to handle this plugin

getReferenceMode() - Method in interface com.atlassian.plugin.PluginArtifact

getRequiredPermissions(Class<?>) - Static method in class com.atlassian.plugin.Permissions

getRequiredPlugins() - Method in class com.atlassian.plugin.DummyPlugin

getRequiredPlugins() - Method in interface com.atlassian.plugin.Plugin

Deprecated.

Use Plugin.getDependencies() instead. Since 4.0

getResource(String) - Method in class com.atlassian.plugin.DummyPlugin

getResource(String) - Method in interface com.atlassian.plugin.Plugin

Retrieve the URL of the resource from the plugin.

getResourceAsStream(String) - Method in class com.atlassian.plugin.DummyPlugin

getResourceAsStream(String) - Method in interface com.atlassian.plugin.Plugin

Load a given resource from the plugin.

getResourceAsStream(String) - Method in interface com.atlassian.plugin.PluginArtifact

getResourceDescriptor(String, String) - Method in class com.atlassian.plugin.DummyPlugin

getResourceDescriptor(String, String) - Method in interface com.atlassian.plugin.Resourced

Get a ResourceDescriptor of a particular type and name.

getResourceDescriptor(String, String) - Method in class com.atlassian.plugin.Resources

getResourceDescriptors() - Method in class com.atlassian.plugin.DummyPlugin

getResourceDescriptors(String) - Method in class com.atlassian.plugin.DummyPlugin

getResourceDescriptors(Element) - Static method in class com.atlassian.plugin.loaders.LoaderUtils

Deprecated.

use Resources.fromXml(org.dom4j.Element)

getResourceDescriptors() - Method in interface com.atlassian.plugin.Resourced

Get a List of all the descriptors .

getResourceDescriptors(String) - Method in interface com.atlassian.plugin.Resourced

Deprecated.

since 2.5.0 use Resourced.getResourceDescriptors() and filter as required

getResourceDescriptors() - Method in class com.atlassian.plugin.Resources

getResourceDescriptors(String) - Method in class com.atlassian.plugin.Resources

Deprecated.

getResourceLocation(String, String) - Method in class com.atlassian.plugin.DummyPlugin

getResourceLocation(String, String) - Method in interface com.atlassian.plugin.Resourced

Get a ResourceLocation of a particular type and name.

getResourceLocation(String, String) - Method in class com.atlassian.plugin.Resources

getResourceLocationForName(String) - Method in class com.atlassian.plugin.elements.ResourceDescriptor

Used for resource descriptors that specify multiple resources, via ResourceDescriptor.pattern.

getScopeKey() - Method in class com.atlassian.plugin.PluginInformation

getScopeKey() - Method in interface com.atlassian.plugin.ScopeAware

getStartup() - Method in class com.atlassian.plugin.PluginInformation

getState() - Method in class com.atlassian.plugin.event.events.PluginDependentsChangedEvent

End state of plugin that caused this event.

getType() - Method in class com.atlassian.plugin.elements.ResourceDescriptor

getType() - Method in class com.atlassian.plugin.elements.ResourceLocation

getVendorName() - Method in class com.atlassian.plugin.PluginInformation

getVendorUrl() - Method in class com.atlassian.plugin.PluginInformation

getVersion() - Method in interface com.atlassian.plugin.Application

The version of the application, as a string.

getVersion() - Method in class com.atlassian.plugin.PluginInformation

H

hasAllPermissions() - Method in class com.atlassian.plugin.DummyPlugin

hasAllPermissions() - Method in interface com.atlassian.plugin.Plugin

hashCode() - Method in class com.atlassian.plugin.elements.ResourceDescriptor

hashCode() - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit

hashCode() - Method in class com.atlassian.plugin.ModuleCompleteKey

hashCode() - Method in interface com.atlassian.plugin.ModuleDescriptor

Returns the hash code value for this module descriptor.

hashCode() - Method in class com.atlassian.plugin.PluginPermission

hasModuleDescriptor(String) - Method in interface com.atlassian.plugin.ModuleDescriptorFactory

HostContainer - Interface in com.atlassian.plugin.hostcontainer

Interface into the host application's dependency injection system.

I

init(Plugin, Element) - Method in interface com.atlassian.plugin.ModuleDescriptor

Initialise a module given it's parent plugin and the XML element representing the module.

init() - Method in interface com.atlassian.plugin.PluginSystemLifecycle

Initialise the plugin system.

injectBean(T) - Method in interface com.atlassian.plugin.module.ContainerAccessor

Injects an existing bean instance with any dependencies via setters or private field injection

install() - Method in class com.atlassian.plugin.DummyPlugin

install() - Method in interface com.atlassian.plugin.Plugin

Installs the plugin into any internal, managing container.

InstallationMode - Enum in com.atlassian.plugin

The mode of installation of a plugin

installPlugin(PluginArtifact) - Method in interface com.atlassian.plugin.PluginController

Deprecated.

Since 2.3.0, use PluginController.installPlugins(PluginArtifact...) instead

installPlugins(PluginArtifact...) - Method in interface com.atlassian.plugin.PluginController

Installs multiple plugins and returns the list of plugin keys.

isActive(ScopeManager, ScopeAware) - Static method in interface com.atlassian.plugin.scope.ScopeManager

isBroken() - Method in interface com.atlassian.plugin.ModuleDescriptor

Returns true if this Module is "broken".

isBundledPlugin() - Method in class com.atlassian.plugin.DummyPlugin

isBundledPlugin() - Method in interface com.atlassian.plugin.Plugin

Whether the plugin is a "bundled" plugin that can't be removed.

isDeleteable() - Method in class com.atlassian.plugin.DummyPlugin

isDeleteable() - Method in interface com.atlassian.plugin.Plugin

Should the plugin file be deleted on uninstall?

isDynamicallyLoaded() - Method in class com.atlassian.plugin.DummyPlugin

isDynamicallyLoaded() - Method in interface com.atlassian.plugin.Plugin

Whether or not this plugin is loaded dynamically at runtime.

isEnabled() - Method in class com.atlassian.plugin.DummyPlugin

isEnabled() - Method in interface com.atlassian.plugin.ModuleDescriptor

Get whether this plugin module is enabled.

isEnabled() - Method in interface com.atlassian.plugin.Plugin

Deprecated.

since 2.2.0, use Plugin.getPluginState() instead

isEnabledByDefault() - Method in class com.atlassian.plugin.DummyPlugin

isEnabledByDefault() - Method in interface com.atlassian.plugin.ModuleDescriptor

Whether or not this plugin module is enabled by default.

isEnabledByDefault() - Method in interface com.atlassian.plugin.Plugin

isPersistent() - Method in class com.atlassian.plugin.event.events.PluginModulePersistentEvent

isPluginEnabled(String) - Method in interface com.atlassian.plugin.PluginAccessor

Whether or not a given plugin is currently enabled.

isPluginModuleEnabled(String) - Method in interface com.atlassian.plugin.PluginAccessor

Whether or not a given plugin module is currently enabled.

isScopeActive(String) - Method in interface com.atlassian.plugin.scope.ScopeManager

isSystemModule() - Method in interface com.atlassian.plugin.ModuleDescriptor

Whether or not this plugin module is a "system" module that shouldn't be made visible/disable-able to the user.

isSystemPlugin() - Method in class com.atlassian.plugin.DummyPlugin

isSystemPlugin() - Method in interface com.atlassian.plugin.Plugin

Deprecated.

since 2.6.0 use com.atlassian.plugin.metadata.PluginMetadataManager#isSystemProvided(Plugin)} instead.

isSystemPlugin(String) - Method in interface com.atlassian.plugin.PluginAccessor

isTrue(String, boolean) - Static method in class com.atlassian.plugin.util.Assertions

isUninstallable() - Method in class com.atlassian.plugin.DummyPlugin

isUninstallable() - Method in interface com.atlassian.plugin.Plugin

Whether or not this plugin can be 'uninstalled'.

J

JavaVersionUtils - Class in com.atlassian.plugin.util

A simple utility for comparing a java version number to the running version.

JavaVersionUtils() - Constructor for class com.atlassian.plugin.util.JavaVersionUtils

L

lastModified() - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit

LEGACY_MODULE_FACTORY - Static variable in interface com.atlassian.plugin.module.ModuleFactory

Returns the module class.

LegacyModuleFactory - Class in com.atlassian.plugin.module

Legacy module factory that provides module classes for descriptors that aren't using an injected ModuleFactory

LegacyModuleFactory() - Constructor for class com.atlassian.plugin.module.LegacyModuleFactory

lessSignificant(PluginDependencies.Type) - Method in enum com.atlassian.plugin.PluginDependencies.Type

loadClass(String, Class<?>) - Method in class com.atlassian.plugin.DummyPlugin

loadClass(String, Class<?>) - Method in interface com.atlassian.plugin.Plugin

Get the plugin to load a specific class.

LoaderUtils - Class in com.atlassian.plugin.loaders

LoaderUtils() - Constructor for class com.atlassian.plugin.loaders.LoaderUtils

M

matches(ModuleDescriptor<? extends T>) - Method in interface com.atlassian.plugin.predicate.ModuleDescriptorPredicate

Will match a plugin module according to implementation rules.

matches(Plugin) - Method in interface com.atlassian.plugin.predicate.PluginPredicate

Will match a plugin according to implementation rules.

ModuleClassNotFoundException - Exception in com.atlassian.plugin.module

If a module class could not be found

ModuleClassNotFoundException(String, String, String, Exception, String) - Constructor for exception com.atlassian.plugin.module.ModuleClassNotFoundException

ModuleCompleteKey - Class in com.atlassian.plugin

Represents the fully qualified key of a plugin module.

ModuleCompleteKey(String) - Constructor for class com.atlassian.plugin.ModuleCompleteKey

Constructs a ModuleCompleteKey given the String representation of the complete key.

ModuleCompleteKey(String, String) - Constructor for class com.atlassian.plugin.ModuleCompleteKey

Constructs a ModuleCompleteKey given the separate plugin key and module key.

ModuleDescriptor<T> - Interface in com.atlassian.plugin

ModuleDescriptorFactory - Interface in com.atlassian.plugin

ModuleDescriptorPredicate<T> - Interface in com.atlassian.plugin.predicate

Interface used to match plugin modules according to implementation specific rules.

ModuleFactory - Interface in com.atlassian.plugin.module

The ModuleFactory creates the module class of a ModuleDescriptor.

N

NAME_COMPARATOR - Static variable in interface com.atlassian.plugin.Plugin

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.

NotificationException - Exception in com.atlassian.plugin.event

This is used to wrap one or more exceptions thrown by Plugin Event Listeners on receiving an event.

NotificationException(Throwable) - Constructor for exception com.atlassian.plugin.event.NotificationException

Constructs a NotificationException with a single caused by Exception thrown by a Listener.

NotificationException(List<Throwable>) - Constructor for exception com.atlassian.plugin.event.NotificationException

Constructs a NotificationException with a List of the Exceptions that were thrown by the Listeners.

notNull(String, T) - Static method in class com.atlassian.plugin.util.Assertions

O

of(String) - Static method in enum com.atlassian.plugin.InstallationMode

P

Permissions - Class in com.atlassian.plugin

Plugin - Interface in com.atlassian.plugin

Plugin.EnabledMetricsSource - Interface in com.atlassian.plugin

Deprecated.

since 4.0.0, to be removed in 5.0.0: Methods in this interface are now provided directly by Plugin.

Plugin.EnabledMetricsSource.Default - Class in com.atlassian.plugin

Deprecated.

Host to default implementations of the Plugin.EnabledMetricsSource methods.

Plugin.Resolvable - Interface in com.atlassian.plugin

Deprecated.

since 4.0.0, to be removed in 5.0.0: Methods in this interface are now provided directly by Plugin.

Plugin.Resolvable.Default - Class in com.atlassian.plugin

Deprecated.

Host to default implementation of Plugin.Resolvable.

PluginAccessor - Interface in com.atlassian.plugin

Allows access to the current plugin system state

PluginAccessor.Descriptor - Class in com.atlassian.plugin

The plugin descriptor file.

PluginArtifact - Interface in com.atlassian.plugin

Allows the retrieval of files and/or an input stream of a plugin artifact.

PluginArtifact.AllowsReference - Interface in com.atlassian.plugin

Deprecated.

since 4.0.0, to be removed in 5.0.0: Equivalent functionality is now provided directly by PluginArtifact.getReferenceMode().

PluginArtifact.AllowsReference.Default - Class in com.atlassian.plugin

Deprecated.

Host to default implementation of PluginArtifact.AllowsReference.allowsReference().

PluginArtifact.AllowsReference.ReferenceMode - Enum in com.atlassian.plugin

Deprecated.

PluginArtifact.HasExtraModuleDescriptors - Interface in com.atlassian.plugin

PluginContainerFailedEvent - Class in com.atlassian.plugin.event.events

Event thrown when the container a plugin is installed into either rejects the plugin or fails altogether.

PluginContainerFailedEvent(Object, String, Throwable) - Constructor for class com.atlassian.plugin.event.events.PluginContainerFailedEvent

PluginContainerRefreshedEvent - Class in com.atlassian.plugin.event.events

Event for when the container a plugin is installed into has been refreshed.

PluginContainerRefreshedEvent(Object, String) - Constructor for class com.atlassian.plugin.event.events.PluginContainerRefreshedEvent

PluginContainerUnavailableEvent - Class in com.atlassian.plugin.event.events

Event for when the container of a plugin is been shutdown, usually as a result of the OSGi bundle being stopped.

PluginContainerUnavailableEvent(String) - Constructor for class com.atlassian.plugin.event.events.PluginContainerUnavailableEvent

PluginController - Interface in com.atlassian.plugin

Interface to control the state of the plugin system

PluginDependencies - Class in com.atlassian.plugin

All plugin keys which are dependents of another plugin, divided into OSGi style import resolutions: mandatory (default), optional and dynamic.

PluginDependencies() - Constructor for class com.atlassian.plugin.PluginDependencies

PluginDependencies(Set<String>, Set<String>, Set<String>) - Constructor for class com.atlassian.plugin.PluginDependencies

PluginDependencies.Builder - Class in com.atlassian.plugin

PluginDependencies.Type - Enum in com.atlassian.plugin

PluginDependentsChangedEvent - Class in com.atlassian.plugin.event.events

Event fired after dependent plugins have changed their state in response to a change in this plugin's state i.e.

PluginDependentsChangedEvent(Plugin, PluginState, Set<Plugin>, Set<Plugin>) - Constructor for class com.atlassian.plugin.event.events.PluginDependentsChangedEvent

PluginDisabledEvent - Class in com.atlassian.plugin.event.events

Event that signifies a plugin has been disabled, uninstalled, or updated.

PluginDisabledEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginDisabledEvent

PluginDisablingEvent - Class in com.atlassian.plugin.event.events

Event fired before a plugin is disabled.

PluginDisablingEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginDisablingEvent

PluginEnabledEvent - Class in com.atlassian.plugin.event.events

Event fired when a plugin is enabled, installed, or updated.

PluginEnabledEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginEnabledEvent

PluginEnablingEvent - Class in com.atlassian.plugin.event.events

Event fired before a Plugin is enabled.

PluginEnablingEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginEnablingEvent

PluginEvent - Class in com.atlassian.plugin.event.events

Base class for events with Plugin context.

PluginEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginEvent

PluginEventListener - Annotation Type in com.atlassian.plugin.event

Marks a method that is interested in plugin events

PluginEventManager - Interface in com.atlassian.plugin.event

Defines the event manager for use with internal Atlassian Plugins framework events.

PluginException - Exception in com.atlassian.plugin

Generic plugin exception.

PluginException() - Constructor for exception com.atlassian.plugin.PluginException

PluginException(String) - Constructor for exception com.atlassian.plugin.PluginException

PluginException(Throwable) - Constructor for exception com.atlassian.plugin.PluginException

PluginException(String, Throwable) - Constructor for exception com.atlassian.plugin.PluginException

PluginFactory - Interface in com.atlassian.plugin.factories

Creates the plugin artifact and deploys it into the appropriate plugin management system

PluginFrameworkDelayedEvent - Class in com.atlassian.plugin.event.events

Event that signifies the plugin framework is delayed after early startup and is waiting to commence late startup.

PluginFrameworkDelayedEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkDelayedEvent

PluginFrameworkEvent - Class in com.atlassian.plugin.event.events

Base class for events with plugin framework context.

PluginFrameworkEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkEvent

PluginFrameworkResumingEvent - Class in com.atlassian.plugin.event.events

Event that signifies the plugin framework has resumed initialization in response to lateStartup.

PluginFrameworkResumingEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkResumingEvent

PluginFrameworkShutdownEvent - Class in com.atlassian.plugin.event.events

Event that signifies the plugin framework has been shutdown.

PluginFrameworkShutdownEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkShutdownEvent

PluginFrameworkShuttingDownEvent - Class in com.atlassian.plugin.event.events

Event that signifies the plugin framework is about to be shutdown.

PluginFrameworkShuttingDownEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkShuttingDownEvent

PluginFrameworkStartedEvent - Class in com.atlassian.plugin.event.events

Event that signifies the plugin framework has been started and initialized.

PluginFrameworkStartedEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkStartedEvent

PluginFrameworkStartingEvent - Class in com.atlassian.plugin.event.events

Event that signifies the plugin framework is being started.

PluginFrameworkStartingEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkStartingEvent

PluginFrameworkWarmRestartedEvent - Class in com.atlassian.plugin.event.events

Signals a warm restart of the plugin framework has been completed.

PluginFrameworkWarmRestartedEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkWarmRestartedEvent

PluginFrameworkWarmRestartingEvent - Class in com.atlassian.plugin.event.events

Signals a warm restart of the plugin framework is about to begin.

PluginFrameworkWarmRestartingEvent(PluginController, PluginAccessor) - Constructor for class com.atlassian.plugin.event.events.PluginFrameworkWarmRestartingEvent

PluginInformation - Class in com.atlassian.plugin

PluginInformation() - Constructor for class com.atlassian.plugin.PluginInformation

PluginInstalledEvent - Class in com.atlassian.plugin.event.events

Event fired after a plugin is installed at runtime.

PluginInstalledEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginInstalledEvent

PluginInstallingEvent - Class in com.atlassian.plugin.event.events

Event fired before a plugin is installed at runtime.

PluginInstallingEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginInstallingEvent

PluginModuleAvailableEvent - Class in com.atlassian.plugin.event.events

Signifies a plugin module is now available outside the usual installation process.

PluginModuleAvailableEvent(ModuleDescriptor) - Constructor for class com.atlassian.plugin.event.events.PluginModuleAvailableEvent

PluginModuleDisabledEvent - Class in com.atlassian.plugin.event.events

Event fired when a plugin module is disabled, which can also happen when its plugin is disabled or uninstalled.

PluginModuleDisabledEvent(ModuleDescriptor<?>, boolean) - Constructor for class com.atlassian.plugin.event.events.PluginModuleDisabledEvent

PluginModuleDisablingEvent - Class in com.atlassian.plugin.event.events

Event fired when a plugin module is about to be disabled, which can also happen when its plugin is about to be disabled or uninstalled.

PluginModuleDisablingEvent(ModuleDescriptor<?>, boolean) - Constructor for class com.atlassian.plugin.event.events.PluginModuleDisablingEvent

PluginModuleEnabledEvent - Class in com.atlassian.plugin.event.events

Event fired when a plugin module is enabled, which can also happen when its plugin is enabled or installed.

PluginModuleEnabledEvent(ModuleDescriptor<?>) - Constructor for class com.atlassian.plugin.event.events.PluginModuleEnabledEvent

PluginModuleEnablingEvent - Class in com.atlassian.plugin.event.events

Event fired when a plugin module is about to be enabled, which can also happen when its plugin is about to be enabled or installed.

PluginModuleEnablingEvent(ModuleDescriptor<?>) - Constructor for class com.atlassian.plugin.event.events.PluginModuleEnablingEvent

PluginModuleEvent - Class in com.atlassian.plugin.event.events

Base class for events with ModuleDescriptor context.

PluginModuleEvent(ModuleDescriptor<?>) - Constructor for class com.atlassian.plugin.event.events.PluginModuleEvent

PluginModulePersistentEvent - Class in com.atlassian.plugin.event.events

Base class for events with persistent flag in addition to ModuleDescriptor context.

PluginModulePersistentEvent(ModuleDescriptor<?>, boolean) - Constructor for class com.atlassian.plugin.event.events.PluginModulePersistentEvent

PluginModuleUnavailableEvent - Class in com.atlassian.plugin.event.events

Signifies a plugin module is now unavailable outside the usual installation process.

PluginModuleUnavailableEvent(ModuleDescriptor<?>) - Constructor for class com.atlassian.plugin.event.events.PluginModuleUnavailableEvent

PluginParseException - Exception in com.atlassian.plugin

Parse plugin exception - thrown from code which must parse a plugin.

PluginParseException() - Constructor for exception com.atlassian.plugin.PluginParseException

PluginParseException(String) - Constructor for exception com.atlassian.plugin.PluginParseException

PluginParseException(Throwable) - Constructor for exception com.atlassian.plugin.PluginParseException

PluginParseException(String, Throwable) - Constructor for exception com.atlassian.plugin.PluginParseException

PluginPermission - Class in com.atlassian.plugin

Represents a plugin permission as parsed from the plugin descriptor.

PluginPermission(String) - Constructor for class com.atlassian.plugin.PluginPermission

PluginPermission(String, InstallationMode) - Constructor for class com.atlassian.plugin.PluginPermission

PluginPermission(String, Option<InstallationMode>) - Constructor for class com.atlassian.plugin.PluginPermission

PluginPredicate - Interface in com.atlassian.plugin.predicate

Interface used to match plugins according to implementation specific rules.

PluginRefreshedEvent - Class in com.atlassian.plugin.event.events

Event fired when the plugin has been refreshed with no user interaction.

PluginRefreshedEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginRefreshedEvent

PluginRegistry - Interface in com.atlassian.plugin

PluginRegistry.ReadOnly - Interface in com.atlassian.plugin

PluginRegistry.ReadWrite - Interface in com.atlassian.plugin

PluginRestartState - Enum in com.atlassian.plugin

The state of the plugin after restart.

PluginState - Enum in com.atlassian.plugin

Represents the state of the plugin

PluginSystemLifecycle - Interface in com.atlassian.plugin

Controls the life-cycle of the plugin system.

PluginUninstalledEvent - Class in com.atlassian.plugin.event.events

Event fired when a plugin is explicitly uninstalled (as opposed to as part of an upgrade).

PluginUninstalledEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginUninstalledEvent

PluginUninstallingEvent - Class in com.atlassian.plugin.event.events

Event fired before a plugin is explicitly uninstalled (as opposed to as part of an upgrade).

PluginUninstallingEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginUninstallingEvent

PluginUpgradedEvent - Class in com.atlassian.plugin.event.events

Event fired after a plugin is upgraded at runtime.

PluginUpgradedEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginUpgradedEvent

PluginUpgradingEvent - Class in com.atlassian.plugin.event.events

Event fired before a plugin is upgraded at runtime.

PluginUpgradingEvent(Plugin) - Constructor for class com.atlassian.plugin.event.events.PluginUpgradingEvent

put(Plugin) - Method in interface com.atlassian.plugin.PluginRegistry.ReadWrite

R

ReferenceMode - Enum in com.atlassian.plugin

A named boolean for specifying whether to allow reference installation of plugins.

register(Object) - Method in interface com.atlassian.plugin.event.PluginEventManager

Registers a listener object

remove(String) - Method in interface com.atlassian.plugin.PluginRegistry.ReadWrite

removeDynamicModule(Plugin, ModuleDescriptor<?>) - Method in interface com.atlassian.plugin.PluginController

Remove a module that was dynamically added to plugin..

RequirePermission - Annotation Type in com.atlassian.plugin

A list of permissions to fulfill.

resolve() - Method in class com.atlassian.plugin.DummyPlugin

resolve(Plugin) - Static method in class com.atlassian.plugin.Plugin.Resolvable.Default

Deprecated.

Forwards to plugin.resolve().

resolve() - Method in interface com.atlassian.plugin.Plugin.Resolvable

Deprecated.

resolve() - Method in interface com.atlassian.plugin.Plugin

Perform any required resolution.

resolveVersionFromString(String) - Static method in class com.atlassian.plugin.util.JavaVersionUtils

Resourced - Interface in com.atlassian.plugin

ResourceDescriptor - Class in com.atlassian.plugin.elements

ResourceDescriptor(Element) - Constructor for class com.atlassian.plugin.elements.ResourceDescriptor

ResourceLocation - Class in com.atlassian.plugin.elements

This class gives the location of a particular resource

ResourceLocation(String, String, String, String, String, Map<String, String>) - Constructor for class com.atlassian.plugin.elements.ResourceLocation

Resources - Class in com.atlassian.plugin

An aggregate of all resource descriptors within the given plugin module or plugin.

Resources(Iterable<ResourceDescriptor>) - Constructor for class com.atlassian.plugin.Resources

Deprecated.

Since 3.0.1, use Resources.fromXml(org.dom4j.Element) instead. This will lazily create the ResourceDescriptors from the Element, for a memory saving.

Resources.TypeFilter - Class in com.atlassian.plugin

revertRestartRequiredChange(String) - Method in interface com.atlassian.plugin.PluginController

Restores the state of any plugin requiring a restart that had been removed, upgraded, or installed.

S

satisfiesMinJavaVersion() - Method in interface com.atlassian.plugin.ModuleDescriptor

If a min java version has been specified this will return true if the running jvm is >= to the specified version.

satisfiesMinJavaVersion() - Method in class com.atlassian.plugin.PluginInformation

satisfiesMinVersion(float) - Static method in class com.atlassian.plugin.util.JavaVersionUtils

scanForNewPlugins() - Method in interface com.atlassian.plugin.PluginController

Search all loaders and add any new plugins you find.

ScopeAware - Interface in com.atlassian.plugin

Makes class scope aware.

ScopeManager - Interface in com.atlassian.plugin.scope

Entry point for scope checks.

SEPARATOR - Static variable in class com.atlassian.plugin.ModuleCompleteKey

setBroken() - Method in interface com.atlassian.plugin.ModuleDescriptor

Changes state to "broken"

setDescription(String) - Method in class com.atlassian.plugin.PluginInformation

setDescriptionKey(String) - Method in class com.atlassian.plugin.PluginInformation

setEnabled(boolean) - Method in class com.atlassian.plugin.DummyPlugin

setEnabled(boolean) - Method in interface com.atlassian.plugin.Plugin

Deprecated.

Since 2.2.0, use Plugin.enable() or Plugin.disable() instead

setEnabledByDefault(boolean) - Method in class com.atlassian.plugin.DummyPlugin

setEnabledByDefault(boolean) - Method in interface com.atlassian.plugin.Plugin

setI18nNameKey(String) - Method in class com.atlassian.plugin.DummyPlugin

setI18nNameKey(String) - Method in interface com.atlassian.plugin.Plugin

Sets the i18nKey used to get an internationalised name for this plugin.

setKey(String) - Method in class com.atlassian.plugin.DummyPlugin

setKey(String) - Method in interface com.atlassian.plugin.Plugin

setMaxVersion(float) - Method in class com.atlassian.plugin.PluginInformation

Deprecated.

Since 2.2.0

setMinJavaVersion(Float) - Method in class com.atlassian.plugin.PluginInformation

setMinVersion(float) - Method in class com.atlassian.plugin.PluginInformation

Deprecated.

Since 2.2.0

setModuleScanFolders(Iterable<String>) - Method in class com.atlassian.plugin.PluginInformation

setName(String) - Method in class com.atlassian.plugin.DummyPlugin

setName(String) - Method in interface com.atlassian.plugin.Plugin

Sets the non-localised name of this plugin.

setPermissions(Set<PluginPermission>) - Method in class com.atlassian.plugin.PluginInformation

setPluginInformation(PluginInformation) - Method in class com.atlassian.plugin.DummyPlugin

setPluginInformation(PluginInformation) - Method in interface com.atlassian.plugin.Plugin

setPluginsVersion(int) - Method in class com.atlassian.plugin.DummyPlugin

setPluginsVersion(int) - Method in interface com.atlassian.plugin.Plugin

Sets the version of the plugins system

setResources(Resourced) - Method in class com.atlassian.plugin.DummyPlugin

setResources(Resourced) - Method in interface com.atlassian.plugin.Plugin

setScopeKey(Optional<String>) - Method in class com.atlassian.plugin.PluginInformation

setStartup(String) - Method in class com.atlassian.plugin.PluginInformation

setSystemPlugin(boolean) - Method in class com.atlassian.plugin.DummyPlugin

setSystemPlugin(boolean) - Method in interface com.atlassian.plugin.Plugin

Deprecated.

since 2.6.0 provide com.atlassian.plugin.metadata.PluginMetadataManager with information about the plugin instead. There is no way to programatically set this value now.

setVendorName(String) - Method in class com.atlassian.plugin.PluginInformation

setVendorUrl(String) - Method in class com.atlassian.plugin.PluginInformation

setVersion(String) - Method in class com.atlassian.plugin.PluginInformation

shutdown() - Method in interface com.atlassian.plugin.PluginSystemLifecycle

Destroys the plugin manager.

StateAware - Interface in com.atlassian.plugin

Makes a plugin or plugin module aware of its activation state.

T

toFile() - Method in interface com.atlassian.plugin.PluginArtifact

toString() - Method in class com.atlassian.plugin.event.events.PluginDependentsChangedEvent

toString() - Method in class com.atlassian.plugin.event.events.PluginEvent

toString() - Method in class com.atlassian.plugin.event.events.PluginModuleEvent

toString() - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit

toString() - Method in class com.atlassian.plugin.ModuleCompleteKey

TypeFilter(String) - Constructor for class com.atlassian.plugin.Resources.TypeFilter

U

uninstall() - Method in class com.atlassian.plugin.DummyPlugin

uninstall() - Method in interface com.atlassian.plugin.Plugin

Uninstalls the plugin from any internal container.

uninstall(Plugin) - Method in interface com.atlassian.plugin.PluginController

Uninstall the plugin, disabling it first.

uninstallPlugins(Collection<Plugin>) - Method in interface com.atlassian.plugin.PluginController

Uninstall multiple plugin, disabling it first.

unregister(Object) - Method in interface com.atlassian.plugin.event.PluginEventManager

Unregisters a listener object

V

valueOf(String) - Static method in enum com.atlassian.plugin.InstallationMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.plugin.PluginArtifact.AllowsReference.ReferenceMode

Deprecated.

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.plugin.PluginDependencies.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.plugin.PluginRestartState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.plugin.PluginState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.plugin.ReferenceMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.atlassian.plugin.InstallationMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.plugin.PluginArtifact.AllowsReference.ReferenceMode

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.plugin.PluginDependencies.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.plugin.PluginRestartState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.plugin.PluginState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.plugin.ReferenceMode

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION_1 - Static variable in interface com.atlassian.plugin.Plugin

This is the historical version of plugins.

VERSION_2 - Static variable in interface com.atlassian.plugin.Plugin

This is the version of plugins which introduced dynamic plugins for all.

VERSION_3 - Static variable in interface com.atlassian.plugin.Plugin

This is the versions of plugins that adds remotes plugins (developed outside of the plugin framework itself).

W

warmRestart() - Method in interface com.atlassian.plugin.PluginSystemLifecycle

Restart all plugins by disabling and enabling them in the order they were loaded (by plugin loader)

withDynamic(String...) - Method in class com.atlassian.plugin.PluginDependencies.Builder

withMandatory(String...) - Method in class com.atlassian.plugin.PluginDependencies.Builder

withOptional(String...) - Method in class com.atlassian.plugin.PluginDependencies.Builder

A B C D E F G H I J L M N O P R S T U V W