Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addDynamicModule(Plugin, Element) - Method in interface com.atlassian.plugin.PluginController
-
Add a new module described by
elementto 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 enum class com.atlassian.plugin.ReferenceMode
- Application - Interface in com.atlassian.plugin
-
This represents the application that uses the plugin system.
- Assertions - Class in com.atlassian.plugin.util
-
Design by contract assertions.
- attributeNames() - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- attributeNames() - Method in interface com.atlassian.plugin.module.Element
- attributeValue(String) - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- attributeValue(String) - Method in interface com.atlassian.plugin.module.Element
-
Returns the value for an attribute based on the provided key.
- attributeValue(String, String) - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- attributeValue(String, String) - Method in interface com.atlassian.plugin.module.Element
-
Returns the value for an attribute based on the provided key.
B
- 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
- 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.internal.module - package com.atlassian.plugin.internal.module
- com.atlassian.plugin.loaders - package com.atlassian.plugin.loaders
- com.atlassian.plugin.loaders.classloading - package com.atlassian.plugin.loaders.classloading
- com.atlassian.plugin.manager - package com.atlassian.plugin.manager
- com.atlassian.plugin.metadata - package com.atlassian.plugin.metadata
- 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(DeploymentUnit) - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit
- compareTo(Plugin) - Method in class com.atlassian.plugin.DummyPlugin
- 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(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
- 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() - 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.
- DISABLED - Enum constant in enum class com.atlassian.plugin.PluginState
-
The plugin has been disabled
- 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.
- DISABLING - Enum constant in enum class com.atlassian.plugin.PluginState
-
The plugin is in the process of being disabled
- doesResourceExist(String) - Method in interface com.atlassian.plugin.PluginArtifact
- doesTypeAndNameMatch(String, String) - Method in class com.atlassian.plugin.elements.ResourceDescriptor
- Dom4jDelegatingElement - Class in com.atlassian.plugin.internal.module
-
This class is provided as a migration path and should not be depended upon directly as will not be provided in the public API as of atlassian plugins 8.0.0.
- Dom4jDelegatingElement(Element) - Constructor for class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
-
Not for external use, we cannot guarantee the version of dom4j that will be provided.
- 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
- DYNAMIC - Enum constant in enum class com.atlassian.plugin.PluginDependencies.Type
E
- element(String) - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- element(String) - Method in interface com.atlassian.plugin.module.Element
-
Returns the first element which matches the given name
- Element - Interface in com.atlassian.plugin.module
-
This represents a given element in the atlassian-plugin.xml.
- elements() - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- elements() - Method in interface com.atlassian.plugin.module.Element
- elements(String) - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- elements(String) - Method in interface com.atlassian.plugin.module.Element
-
Returns all elements which matches the given name
- elementTextTrim(String) - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- elementTextTrim(String) - Method in interface com.atlassian.plugin.module.Element
- 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.
- ENABLED - Enum constant in enum class com.atlassian.plugin.PluginState
-
The plugin has been enabled
- 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.
- ENABLING - Enum constant in enum class com.atlassian.plugin.PluginState
-
The plugin is in the process of being enabled
- equals(DeploymentUnit) - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit
- equals(Object) - Method in class com.atlassian.plugin.elements.ResourceDescriptor
- equals(Object) - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- equals(Object) - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit
- equals(Object) - Method in class com.atlassian.plugin.manager.PluginEnabledState
- 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.
- FORBID_REFERENCE - Enum constant in enum class com.atlassian.plugin.ReferenceMode
-
ReferenceMode.allowsReferencereturns false. - 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() - Method in interface com.atlassian.plugin.StoredPluginStateAccessor
-
Get the saved activation state of loaded plugins or modules.
- get(String) - Method in interface com.atlassian.plugin.PluginRegistry.ReadOnly
- getActiveModuleDescriptorsByClass(Class<D>) - Method in interface com.atlassian.plugin.PluginAccessor
-
Deprecated.
- 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(Class<T>) - Method in interface com.atlassian.plugin.module.ContainerAccessor
-
Gets single bean of given type
- 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.
- 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() - 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() - 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.
- getDelegate() - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- 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
- getDisplayName() - Method in interface com.atlassian.plugin.ModuleDescriptor
-
Returns the display name of this descriptor, e.g.
- 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.
- 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.
- getEnabledModulesByClass(Class<M>) - Method in interface com.atlassian.plugin.PluginAccessor
-
Retrieve all plugin modules that implement or extend a specific class.
- 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.
- getFirstPluginKey() - Static method in class com.atlassian.plugin.util.PluginKeyStack
-
The first pluginKey which was pushed to the stack
- 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 class 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
- 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
- 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() - Method in interface com.atlassian.plugin.ModuleDescriptor
-
The class of the module this descriptor creates.
- getModuleClass(String, ModuleDescriptor<T>) - Method in class com.atlassian.plugin.module.LegacyModuleFactory
- 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
ModuleDescriptorfor 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
Collectionofdescriptors. - getModuleDescriptors(ModuleDescriptorPredicate<M>) - Method in interface com.atlassian.plugin.PluginAccessor
-
Deprecated.in 5.0 for removal in 6.0. Use
PluginAccessor.getModuleDescriptors(Predicate)instead. - getModuleDescriptors(Predicate<ModuleDescriptor<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
descriptorswhose module class implements or is assignable from the suppliedClass. - 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
-
Deprecated.in 5.0 for removal in 6.0. Use
PluginAccessor.getModules(Predicate)instead. - getModules(Predicate<ModuleDescriptor<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 class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- getName() - Method in interface com.atlassian.plugin.module.Element
- 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() - Method in interface com.atlassian.plugin.ModuleDescriptor
- getParams(Element) - Static method in class com.atlassian.plugin.loaders.LoaderUtils
- 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
PluginArtifactused to create this plugin instance. - getPluginController() - Method in class com.atlassian.plugin.event.events.PluginFrameworkEvent
- getPluginEnabledStateMap(Plugin) - Method in interface com.atlassian.plugin.StoredPluginState
-
Get state map of the given plugin and its modules.
- getPluginEnabledStateWithCurrentTime(boolean) - Static method in class com.atlassian.plugin.manager.PluginEnabledState
- 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.
- getPluginKeys() - Static method in class com.atlassian.plugin.util.PluginKeyStack
-
A set of pluginKeys which represent the services which the current service has invoked
- getPluginModule(String) - Method in interface com.atlassian.plugin.PluginAccessor
-
Retrieve any plugin module by complete module key.
- getPluginRestartState(String) - Method in interface com.atlassian.plugin.PluginAccessor
-
Gets the state of the plugin upon restart.
- getPluginRestartState(String) - Method in interface com.atlassian.plugin.StoredPluginState
-
Gets whether the plugin is expected to be upgraded, installed, or removed on next 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
-
Deprecated.in 5.0 for removal in 6.0, use
PluginAccessor.getPlugins(Predicate)instead - getPlugins(Predicate<Plugin>) - 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
- 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
ResourceDescriptorof a particular type and name. - getResourceDescriptor(String, String) - Method in class com.atlassian.plugin.Resources
- getResourceDescriptors() - Method in class com.atlassian.plugin.DummyPlugin
- getResourceDescriptors() - Method in interface com.atlassian.plugin.Resourced
-
Get a
Listof all thedescriptors. - getResourceDescriptors() - Method in class com.atlassian.plugin.Resources
- getResourceLocation(String, String) - Method in class com.atlassian.plugin.DummyPlugin
- getResourceLocation(String, String) - Method in interface com.atlassian.plugin.Resourced
-
Get a
ResourceLocationof 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
-
Deprecated.
- 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.
- getStatesMap() - Method in interface com.atlassian.plugin.StoredPluginState
-
Get the map of all states with the update timestamp for each of them.
- getText() - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- getText() - Method in interface com.atlassian.plugin.module.Element
- getTextTrim() - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- getTextTrim() - Method in interface com.atlassian.plugin.module.Element
- getTimestamp() - Method in class com.atlassian.plugin.manager.PluginEnabledState
- getType() - Method in class com.atlassian.plugin.elements.ResourceDescriptor
- getType() - Method in class com.atlassian.plugin.elements.ResourceLocation
- getTypesByPluginKey() - Method in class com.atlassian.plugin.PluginDependencies
- getUnmodifiableEvents() - Method in class com.atlassian.plugin.event.events.PluginTransactionEndEvent
- 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
- hasAnyEventOfTypeMatching(Class<T>, Predicate<T>) - Method in class com.atlassian.plugin.event.events.PluginTransactionEndEvent
-
Returns true if any event of type
eventTypeClassmatchinganyMatchEventPredicatewas part of this transaction. - hasAnyEventWithModuleDescriptorMatching(Predicate<ModuleDescriptor<?>>) - Method in class com.atlassian.plugin.event.events.PluginTransactionEndEvent
-
Returns true if any event of type
PluginModuleEventwithPluginModuleEvent.getModule()matchinganyMatchModuleDescriptorPredicatewas part of this transaction, or if any event of typePluginEventwithPluginEvent.getPlugin()with anyPlugin.getModuleDescriptors()matchinganyMatchModuleDescriptorPredicatewas part of this transaction. - hashCode() - Method in class com.atlassian.plugin.elements.ResourceDescriptor
- hashCode() - Method in class com.atlassian.plugin.internal.module.Dom4jDelegatingElement
- hashCode() - Method in class com.atlassian.plugin.loaders.classloading.DeploymentUnit
- hashCode() - Method in class com.atlassian.plugin.manager.PluginEnabledState
- 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() - Method in interface com.atlassian.plugin.PluginSystemLifecycle
-
Initialise the plugin system.
- init(Plugin, Element) - Method in interface com.atlassian.plugin.ModuleDescriptor
-
Initialise a module given its parent plugin and the XML element representing the module.
- 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.
- INSTALL - Enum constant in enum class com.atlassian.plugin.PluginRestartState
-
Indicates an installation will be performed
- InstallationMode - Enum Class in com.atlassian.plugin
-
The mode of installation of a plugin
- INSTALLED - Enum constant in enum class com.atlassian.plugin.PluginState
-
The plugin has been installed into the plugin system
- 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
-
Deprecated.
- 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.manager.PluginEnabledState
- isEnabled() - Method in interface com.atlassian.plugin.ModuleDescriptor
-
Get whether this plugin module is enabled.
- isEnabled(ModuleDescriptor<?>) - Method in interface com.atlassian.plugin.StoredPluginState
-
Whether or not a given plugin module is enabled, calculated from its persisted state AND default state.
- isEnabled(Plugin) - Method in interface com.atlassian.plugin.StoredPluginState
-
Whether or not a plugin is enabled, calculated from its persisted state AND default state.
- 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
- isOptional(ModuleDescriptor<?>) - Method in interface com.atlassian.plugin.metadata.PluginMetadataManager
-
This is used to determine if a module is considered optional.
- isOptional(Plugin) - Method in interface com.atlassian.plugin.metadata.PluginMetadataManager
-
This is used to determine if a plugin is considered optional.
- 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
-
Deprecated.
- 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
PluginMetadataManager.isSystemProvided(Plugin)} instead. - isSystemPlugin(String) - Method in interface com.atlassian.plugin.PluginAccessor
- isSystemProvided(Plugin) - Method in interface com.atlassian.plugin.metadata.PluginMetadataManager
-
This is used to determine if the plugin was provided by the host application.
- 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'.
- isUserInstalled(Plugin) - Method in interface com.atlassian.plugin.metadata.PluginMetadataManager
-
Determines if the plugin was installed by a user.
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
- 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 class 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
- LOCAL - Enum constant in enum class com.atlassian.plugin.InstallationMode
-
Denotes a plugin installed locally to the host application.
M
- MANDATORY - Enum constant in enum class com.atlassian.plugin.PluginDependencies.Type
- matches(ModuleDescriptor<? extends T>) - Method in interface com.atlassian.plugin.predicate.ModuleDescriptorPredicate
-
Deprecated.Will match a plugin module according to implementation rules.
- matches(Plugin) - Method in interface com.atlassian.plugin.predicate.PluginPredicate
-
Deprecated.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
-
Deprecated.since 5.0 for removal in 6.0
- ModuleFactory - Interface in com.atlassian.plugin.module
-
The
ModuleFactorycreates the module class of aModuleDescriptor.
N
- NONE - Enum constant in enum class com.atlassian.plugin.PluginRestartState
-
Indicates no change upon restart
- 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
- numberOfEvents() - Method in class com.atlassian.plugin.event.events.PluginTransactionEndEvent
O
- of(String) - Static method in enum class com.atlassian.plugin.InstallationMode
- OPTIONAL - Enum constant in enum class com.atlassian.plugin.PluginDependencies.Type
P
- PENDING - Enum constant in enum class com.atlassian.plugin.PluginState
-
A marker value to indicate that a state change is pending.
- Permissions - Class in com.atlassian.plugin
- PERMIT_REFERENCE - Enum constant in enum class com.atlassian.plugin.ReferenceMode
-
ReferenceMode.allowsReferencereturns true. - Plugin - Interface in com.atlassian.plugin
- 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.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 Class 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, List<Plugin>, List<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
- PluginEnabledState - Class in com.atlassian.plugin.manager
-
The state of a plugin with the current status (enabled/disabled) and a timestamp of last state update
- PluginEnabledState(boolean) - Constructor for class com.atlassian.plugin.manager.PluginEnabledState
-
Deprecated.in 4.5 for removal in 6.0. Use
PluginEnabledState(boolean, long)orPluginEnabledState.getPluginEnabledStateWithCurrentTime(boolean)instead - PluginEnabledState(boolean, long) - Constructor for class com.atlassian.plugin.manager.PluginEnabledState
- 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 Interface 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(String, Throwable) - Constructor for exception com.atlassian.plugin.PluginException
- PluginException(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
- PluginKeyStack - Class in com.atlassian.plugin.util
-
The stack to maintain the keys of a list of services which the service itself invokes.
- PluginMetadataManager - Interface in com.atlassian.plugin.metadata
-
Provides information about plugins and modules that is application host specific.
- 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(String, Throwable) - Constructor for exception com.atlassian.plugin.PluginParseException
- PluginParseException(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
- PluginPredicate - Interface in com.atlassian.plugin.predicate
-
Deprecated.in 5.0 for removal in 6.0
- 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 Class in com.atlassian.plugin
-
The state of the plugin after restart.
- PluginState - Enum Class in com.atlassian.plugin
-
Represents the state of the plugin
- PluginSystemLifecycle - Interface in com.atlassian.plugin
-
Controls the life-cycle of the plugin system.
- PluginTransactionEndEvent - Class in com.atlassian.plugin.event.events
-
Event send at the end of an action wrapping existing plugin events:
PluginEnablingEventPluginEnabledEventPluginDisablingEventPluginDisabledEventPluginModuleDisablingEventPluginModuleDisabledEventPluginModuleEnablingEventPluginModuleEnabledEventPluginRefreshedEventPluginFrameworkStartingEventPluginFrameworkDelayedEventPluginFrameworkResumingEventPluginFrameworkStartedEventPluginFrameworkShuttingDownEventPluginFrameworkShutdownEventPluginFrameworkWarmRestartingEventPluginFrameworkWarmRestartedEventPluginUninstallingEventPluginUninstalledEventPluginInstallingEventPluginInstalledEventPluginUpgradingEventPluginUpgradedEventPluginDependentsChangedEventContains information about plugin events which were part of this transaction. - PluginTransactionEndEvent(List<Object>) - Constructor for class com.atlassian.plugin.event.events.PluginTransactionEndEvent
- PluginTransactionStartEvent - Class in com.atlassian.plugin.event.events
-
Event send at the start of a
PluginControlleraction wrapping existing plugin events. - PluginTransactionStartEvent() - Constructor for class com.atlassian.plugin.event.events.PluginTransactionStartEvent
- 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
- pop() - Static method in class com.atlassian.plugin.util.PluginKeyStack
-
A service will remove a pluginKey from the stack at the point at which the method invocation of another service is complete
- push(String) - Static method in class com.atlassian.plugin.util.PluginKeyStack
-
A service will add a pluginKey to the stack at the point at which it invokes another service
- put(Plugin) - Method in interface com.atlassian.plugin.PluginRegistry.ReadWrite
R
- ReferenceMode - Enum Class 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
- REMOTE - Enum constant in enum class com.atlassian.plugin.InstallationMode
-
Denotes a plugin installed from a remote plugin.
- remove(String) - Method in interface com.atlassian.plugin.PluginRegistry.ReadWrite
- REMOVE - Enum constant in enum class com.atlassian.plugin.PluginRestartState
-
Indicates the plugin will be removed
- removeDynamicModule(Plugin, ModuleDescriptor<?>) - Method in interface com.atlassian.plugin.PluginController
-
Remove a module that was dynamically added to plugin.
- RequirePermission - Annotation Interface in com.atlassian.plugin
-
A list of permissions to fulfill.
- resolve() - Method in class com.atlassian.plugin.DummyPlugin
- 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.TypeFilterPredicate - Class in com.atlassian.plugin
-
Checks that the
ResourceDescriptorhas a matching type, this is determined by comparing theResourceDescriptor.getType()with type supplied to the Constructor of this Predicate. - 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
-
Deprecated.in 5.0 for removal in 6.0
- ScopeManager - Interface in com.atlassian.plugin.scope
-
Deprecated.in 5.0 for removal in 6.0
- 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
- 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
- setMinJavaVersion(Float) - Method in class com.atlassian.plugin.PluginInformation
- 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
PluginMetadataManagerwith 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.
- StoredPluginState - Interface in com.atlassian.plugin
-
A snapshot of persistent state data for all plugins -- whether the plugin has been disabled by the user, and whether anything special is to happen on restart.
- StoredPluginStateAccessor - Interface in com.atlassian.plugin
-
Load a snapshot of the stored state for plugins.
T
- test(ResourceDescriptor) - Method in class com.atlassian.plugin.Resources.TypeFilterPredicate
- threadId() - Method in class com.atlassian.plugin.event.events.PluginTransactionEndEvent
- threadId() - Method in class com.atlassian.plugin.event.events.PluginTransactionStartEvent
- 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
- TypeFilterPredicate(String) - Constructor for class com.atlassian.plugin.Resources.TypeFilterPredicate
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.
- UNINSTALLED - Enum constant in enum class com.atlassian.plugin.PluginState
-
The plugin has been uninstalled and should be unavailable
- uninstallPlugins(Collection<Plugin>) - Method in interface com.atlassian.plugin.PluginController
-
Uninstall multiple plugin, disabling it first.
- UNKNOWN_ENABLED_TIME - Static variable in class com.atlassian.plugin.manager.PluginEnabledState
- unregister(Object) - Method in interface com.atlassian.plugin.event.PluginEventManager
-
Unregisters a listener object
- UPGRADE - Enum constant in enum class com.atlassian.plugin.PluginRestartState
-
Indicates an upgrade will be performed
V
- value() - Element in annotation interface com.atlassian.plugin.RequirePermission
- valueOf(String) - Static method in enum class com.atlassian.plugin.InstallationMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.plugin.PluginDependencies.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.plugin.PluginRestartState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.plugin.PluginState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.plugin.ReferenceMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.atlassian.plugin.InstallationMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.plugin.PluginDependencies.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.plugin.PluginRestartState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.plugin.PluginState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.plugin.ReferenceMode
-
Returns an array containing the constants of this enum class, 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
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
ScopeManageris removed. UsePluginAccessor.getEnabledModuleDescriptorsByClass(Class)instead.