| Modifier and Type | Method and Description |
|---|---|
default <D extends ModuleDescriptor<?>> |
PluginAccessor.getActiveModuleDescriptorsByClass(Class<D> descriptorClazz)
Deprecated.
in 5.0 for removal in 6.0 when
ScopeManager is removed. Use
PluginAccessor.getEnabledModuleDescriptorsByClass(Class) instead. |
<D extends ModuleDescriptor<?>> |
PluginAccessor.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)
Get all enabled module descriptors that have a specific descriptor class.
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
PluginController.addDynamicModule(Plugin plugin,
org.dom4j.Element module)
Add a new module described by
element to the plugin specified. |
ModuleDescriptor<?> |
PluginAccessor.getEnabledPluginModule(String completeKey)
Retrieve an enabled plugin module by complete module key.
|
ModuleDescriptor<?> |
DefaultModuleDescriptorFactory.getModuleDescriptor(String type) |
ModuleDescriptor<?> |
DummyPlugin.getModuleDescriptor(String key) |
ModuleDescriptor<?> |
ModuleDescriptorFactory.getModuleDescriptor(String type) |
ModuleDescriptor<?> |
Plugin.getModuleDescriptor(String key)
Get the
ModuleDescriptor for a particular key. |
ModuleDescriptor<?> |
PluginAccessor.getPluginModule(String completeKey)
Retrieve any plugin module by complete module key.
|
| Modifier and Type | Method and Description |
|---|---|
protected Map<String,Class<? extends ModuleDescriptor>> |
DefaultModuleDescriptorFactory.getDescriptorClassesMap() |
Iterable<ModuleDescriptor<?>> |
PluginInternal.getDynamicModuleDescriptors() |
Iterable<ModuleDescriptor<?>> |
PluginAccessor.getDynamicModules(Plugin plugin)
Retrieve all currently registered dynamic modules i.e.
|
Class<? extends ModuleDescriptor> |
DefaultModuleDescriptorFactory.getModuleDescriptorClass(String type) |
Class<? extends ModuleDescriptor> |
ModuleDescriptorFactory.getModuleDescriptorClass(String type) |
Collection<ModuleDescriptor<?>> |
DummyPlugin.getModuleDescriptors() |
Collection<ModuleDescriptor<?>> |
Plugin.getModuleDescriptors()
Get the
Collection of descriptors. |
default <M> Collection<ModuleDescriptor<M>> |
PluginAccessor.getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
Deprecated.
in 5.0 for removal in 6.0. Use
PluginAccessor.getModuleDescriptors(Predicate) instead. |
<M> Collection<ModuleDescriptor<M>> |
PluginAccessor.getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
Gets all module descriptors of installed modules that match the given predicate.
|
<M> List<ModuleDescriptor<M>> |
DummyPlugin.getModuleDescriptorsByModuleClass(Class<M> moduleClass) |
<M> List<ModuleDescriptor<M>> |
Plugin.getModuleDescriptorsByModuleClass(Class<M> moduleClass)
Get the
descriptors whose module class implements or is assignable from the supplied Class. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
PluginInternal.addDynamicModuleDescriptor(ModuleDescriptor<?> module)
Add a module descriptor.
|
void |
DummyPlugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor) |
void |
Plugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor) |
boolean |
StoredPluginState.isEnabled(ModuleDescriptor<?> pluginModule)
Whether or not a given plugin module is enabled, calculated from its persisted state AND default state.
|
void |
PluginController.removeDynamicModule(Plugin plugin,
ModuleDescriptor<?> module)
Remove a module that was dynamically added to plugin..
|
boolean |
PluginInternal.removeDynamicModuleDescriptor(ModuleDescriptor<?> module)
Remove a module descriptor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultModuleDescriptorFactory.addModuleDescriptor(String type,
Class<? extends ModuleDescriptor> moduleDescriptorClass) |
<M> Collection<ModuleDescriptor<M>> |
PluginAccessor.getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
Gets all module descriptors of installed modules that match the given predicate.
|
<M> Collection<M> |
PluginAccessor.getModules(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
Gets all installed modules that match the given predicate.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractModuleDescriptor<T> |
class |
UnloadableModuleDescriptor
Instances of this class represent a module which could not be loaded, not a module
which can be unloaded.
|
class |
UnrecognisedModuleDescriptor |
class |
UnrecognisedModuleDescriptorRequiringRestart |
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
ChainModuleDescriptorFactory.getModuleDescriptor(String type) |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends ModuleDescriptor> |
ChainModuleDescriptorFactory.getModuleDescriptorClass(String type) |
| Modifier and Type | Method and Description |
|---|---|
static UnloadableModuleDescriptor |
UnloadableModuleDescriptorFactory.createUnloadableModuleDescriptor(Plugin plugin,
ModuleDescriptor<?> descriptor,
Throwable e)
Creates a new UnloadableModuleDescriptor based on an existing ModuleDescriptor, descriptor
This method uses the information in an existing descriptor to construct a new UnloadableModuleDescriptor.
|
ModuleDescriptors.EqualsBuilder |
ModuleDescriptors.EqualsBuilder.descriptor(ModuleDescriptor descriptor)
Sets the module descriptor to create an
equals implementation for. |
ModuleDescriptors.HashCodeBuilder |
ModuleDescriptors.HashCodeBuilder.descriptor(ModuleDescriptor descriptor)
Sets the module descriptor to create a
hashCode implementation for. |
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
PluginModuleEvent.getModule() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
PluginTransactionEndEvent.hasAnyEventWithModuleDescriptorMatching(Predicate<ModuleDescriptor<?>> anyMatchModuleDescriptorPredicate)
Returns true if any event of type
PluginModuleEvent with PluginModuleEvent.getModule() matching
anyMatchModuleDescriptorPredicate was part of this transaction, or if any event of type PluginEvent
with PluginEvent.getPlugin() with any Plugin.getModuleDescriptors() matching
anyMatchModuleDescriptorPredicate was part of this transaction. |
| Constructor and Description |
|---|
PluginModuleAvailableEvent(ModuleDescriptor module) |
PluginModuleDisabledEvent(ModuleDescriptor<?> module,
boolean persistent) |
PluginModuleDisablingEvent(ModuleDescriptor<?> module,
boolean persistent) |
PluginModuleEnabledEvent(ModuleDescriptor<?> module) |
PluginModuleEnablingEvent(ModuleDescriptor<?> module) |
PluginModuleEvent(ModuleDescriptor<?> module) |
PluginModulePersistentEvent(ModuleDescriptor<?> module,
boolean persistent) |
PluginModuleUnavailableEvent(ModuleDescriptor<?> module) |
| Modifier and Type | Class and Description |
|---|---|
class |
EventListenerModuleDescriptor |
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
LegacyDynamicPluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
XmlDynamicPluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
PluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory)
If this factory is capable of loading a plugin of the type passed, attempt to create a module descriptor.
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
AbstractPlugin.getModuleDescriptor(String key) |
| Modifier and Type | Method and Description |
|---|---|
Iterable<ModuleDescriptor<?>> |
AbstractPlugin.getDynamicModuleDescriptors() |
Collection<ModuleDescriptor<?>> |
AbstractPlugin.getModuleDescriptors()
Returns the module descriptors for this plugin
|
<T> List<ModuleDescriptor<T>> |
AbstractPlugin.getModuleDescriptorsByModuleClass(Class<T> aClass) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
AbstractPlugin.addDynamicModuleDescriptor(ModuleDescriptor<?> module) |
void |
AbstractPlugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor) |
boolean |
AbstractPlugin.removeDynamicModuleDescriptor(ModuleDescriptor<?> module) |
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
PluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory)
If this loader is capable of loading a plugin of the type passed, attempt to create a module descriptor.
|
ModuleDescriptor<?> |
ForwardingPluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
ClassPathPluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
SinglePluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
ScanningPluginLoader.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
| Modifier and Type | Method and Description |
|---|---|
<D extends ModuleDescriptor<?>> |
DefaultPluginManager.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)
This method has been reverted to pre PLUG-40 to fix performance issues
that were encountered during load testing.
|
<D extends ModuleDescriptor<?>> |
ProductPluginAccessorBase.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz) |
<D extends ModuleDescriptor<?>> |
EnabledModuleCachingPluginAccessor.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)
This method overrides the same method on PluginAccessor from the plugin system.
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
DefaultPluginManager.addDynamicModule(Plugin maybePluginInternal,
org.dom4j.Element module) |
ModuleDescriptor<?> |
DefaultPluginManager.getEnabledPluginModule(String completeKey) |
ModuleDescriptor<?> |
ProductPluginAccessorBase.getEnabledPluginModule(String completeKey) |
ModuleDescriptor<?> |
DefaultPluginManager.getPluginModule(String completeKey) |
ModuleDescriptor<?> |
ProductPluginAccessorBase.getPluginModule(String completeKey) |
| Modifier and Type | Method and Description |
|---|---|
Iterable<ModuleDescriptor<?>> |
DefaultPluginManager.getDynamicModules(Plugin maybePluginInternal) |
Iterable<ModuleDescriptor<?>> |
ProductPluginAccessorBase.getDynamicModules(Plugin plugin) |
<M> Collection<ModuleDescriptor<M>> |
DefaultPluginManager.getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate) |
<M> Collection<ModuleDescriptor<M>> |
ProductPluginAccessorBase.getModuleDescriptors(Predicate<ModuleDescriptor<M>> predicate) |
| Modifier and Type | Method and Description |
|---|---|
void |
PluginPersistentStateModifier.disable(ModuleDescriptor<?> module) |
void |
PluginPersistentStateModifier.enable(ModuleDescriptor<?> module) |
boolean |
DefaultPluginPersistentState.isEnabled(ModuleDescriptor<?> pluginModule) |
protected void |
DefaultPluginManager.notifyModuleDisabled(ModuleDescriptor<?> module) |
protected void |
DefaultPluginManager.notifyModuleEnabled(ModuleDescriptor<?> module) |
void |
DefaultPluginManager.removeDynamicModule(Plugin maybePluginInternal,
ModuleDescriptor<?> module) |
PluginPersistentState.Builder |
PluginPersistentState.Builder.setEnabled(ModuleDescriptor<?> pluginModule,
boolean isEnabled) |
void |
PluginPersistentStateModifier.setEnabled(ModuleDescriptor<?> module,
boolean enabled) |
| Modifier and Type | Method and Description |
|---|---|
<M> Collection<ModuleDescriptor<M>> |
DefaultPluginManager.getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate) |
<M> Collection<ModuleDescriptor<M>> |
ProductPluginAccessorBase.getModuleDescriptors(Predicate<ModuleDescriptor<M>> predicate) |
<M> List<M> |
SafeModuleExtractor.getModules(Iterable<? extends ModuleDescriptor<M>> moduleDescriptors)
Safely extracts the module instance from the given module descriptors.
|
<M> Collection<M> |
DefaultPluginManager.getModules(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate) |
<M> Collection<M> |
ProductPluginAccessorBase.getModules(Predicate<ModuleDescriptor<M>> predicate) |
Set<String> |
ApplicationDefinedPluginsProvider.getPluginKeys(Iterable<ModuleDescriptor> descriptors)
This method extracts the set of plugin keys from the list of module descriptors
|
boolean |
DefaultSafeModeManager.pluginShouldBeStarted(Plugin plugin,
Iterable<ModuleDescriptor> descriptors) |
boolean |
SafeModeManager.pluginShouldBeStarted(Plugin plugin,
Iterable<ModuleDescriptor> descriptors)
This checks if a plugin should be started when safe-mode is on
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
DefaultPluginMetadataManager.isOptional(ModuleDescriptor<?> moduleDescriptor)
A module is determined to be optional if the host application has not
indicated to the plugins system that it is required.
|
boolean |
PluginMetadataManager.isOptional(ModuleDescriptor<?> moduleDescriptor)
This is used to determine if a module is considered optional.
|
boolean |
ClasspathFilePluginMetadata.required(ModuleDescriptor<?> module) |
| Modifier and Type | Method and Description |
|---|---|
<T> T |
PrefixDelegatingModuleFactory.createModule(String className,
ModuleDescriptor<T> moduleDescriptor) |
<T> T |
ClassPrefixModuleFactory.createModule(String name,
ModuleDescriptor<T> moduleDescriptor) |
<T> T |
LegacyModuleFactory.createModule(String name,
ModuleDescriptor<T> moduleDescriptor) |
<T> T |
ModuleFactory.createModule(String name,
ModuleDescriptor<T> moduleDescriptor)
Creates the module instance.
|
<T> Class<T> |
LegacyModuleFactory.getModuleClass(String name,
ModuleDescriptor<T> moduleDescriptor) |
protected ModuleFactory |
PrefixDelegatingModuleFactory.getModuleFactoryForPrefix(com.atlassian.plugin.module.PrefixDelegatingModuleFactory.ModuleReference moduleReference,
ModuleDescriptor<?> moduleDescriptor)
Returns the module factory for a prefix, first using registered prefixes, then any from the plugin's container.
|
<T> Class<T> |
PrefixDelegatingModuleFactory.guessModuleClass(String name,
ModuleDescriptor<T> moduleDescriptor)
Deprecated.
Since 2.5.0
|
| Modifier and Type | Class and Description |
|---|---|
class |
SingleModuleDescriptorFactory<T extends ModuleDescriptor>
A single module descriptor factory for plugins to use when they want to expose just one plugin.
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor |
SingleModuleDescriptorFactory.getModuleDescriptor(String type) |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends ModuleDescriptor> |
SingleModuleDescriptorFactory.getModuleDescriptorClass(String type) |
Set<Class<? extends ModuleDescriptor>> |
ListableModuleDescriptorFactory.getModuleDescriptorClasses() |
Set<Class<? extends ModuleDescriptor>> |
SingleModuleDescriptorFactory.getModuleDescriptorClasses() |
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
OsgiPluginXmlDescriptorParser.addModule(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin,
org.dom4j.Element module)
Passes module descriptor elements back to the
OsgiPlugin |
ModuleDescriptor<?> |
UnloadableStaticPluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
OsgiBundleFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
OsgiPluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
ModuleDescriptor<?> |
RemotablePluginFactory.createModule(Plugin plugin,
org.dom4j.Element module,
ModuleDescriptorFactory moduleDescriptorFactory) |
protected ModuleDescriptor<?> |
OsgiPluginXmlDescriptorParser.createModuleDescriptor(Plugin plugin,
org.dom4j.Element element,
ModuleDescriptorFactory moduleDescriptorFactory)
Passes module descriptor elements back to the
OsgiPlugin |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends ModuleDescriptor<?>> |
UnavailableModuleDescriptorRequiringRestartFallbackFactory.getModuleDescriptorClass(String type) |
| Modifier and Type | Class and Description |
|---|---|
class |
ComponentImportModuleDescriptor
Module descriptor for OSGi service imports.
|
class |
ComponentModuleDescriptor
Module descriptor for components.
|
class |
ModuleTypeModuleDescriptor
Module descriptor for dynamic module types.
|
| Modifier and Type | Method and Description |
|---|---|
ModuleDescriptor<?> |
ModuleTypeModuleDescriptor.getModule() |
| Modifier and Type | Method and Description |
|---|---|
<T> T |
BeanPrefixModuleFactory.createModule(String name,
ModuleDescriptor<T> moduleDescriptor) |
| Modifier and Type | Method and Description |
|---|---|
static ModuleDescriptor<?> |
XmlDescriptorParserUtils.addModule(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin,
org.dom4j.Element module) |
ModuleDescriptor<?> |
DescriptorParser.addModule(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin,
org.dom4j.Element module)
Create a new module and initialise it with the plugin, then return it.
|
ModuleDescriptor<?> |
XmlDescriptorParser.addModule(ModuleDescriptorFactory moduleDescriptorFactory,
Plugin plugin,
org.dom4j.Element module) |
protected ModuleDescriptor<?> |
XmlDescriptorParser.createModuleDescriptor(Plugin plugin,
org.dom4j.Element element,
ModuleDescriptorFactory moduleDescriptorFactory) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
ModuleDescriptorPredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor)
Deprecated.
Will match a plugin module according to implementation rules.
|
boolean |
EnabledModulePredicate.test(ModuleDescriptor<?> moduleDescriptor) |
boolean |
ModuleDescriptorOfClassPredicate.test(ModuleDescriptor<T> moduleDescriptor) |
boolean |
ModuleOfClassPredicate.test(ModuleDescriptor<T> moduleDescriptor) |
| Constructor and Description |
|---|
ModuleDescriptorOfClassPredicate(Class<? extends ModuleDescriptor<? extends T>> moduleDescriptorClass) |
| Modifier and Type | Class and Description |
|---|---|
class |
DescribedModuleTypeModuleDescriptor
Descriptor that allows described module descriptor factories to be configured in XML.
|
| Modifier and Type | Method and Description |
|---|---|
Set<Class<? extends ModuleDescriptor>> |
DefaultDescribedModuleDescriptorFactory.getModuleDescriptorClasses() |
| Modifier and Type | Class and Description |
|---|---|
class |
BaseServletModuleDescriptor<T>
Acts as a base for other servlet type module descriptors to inherit.
|
class |
ServletContextListenerModuleDescriptor
Provides a way for plugins to declare
ServletContextListeners so they can be notified when the
ServletContext is created for the plugin. |
class |
ServletContextParamModuleDescriptor
Allows plugin developers to specify init parameters they would like added to the plugin local
ServletContext. |
class |
ServletFilterModuleDescriptor
A module descriptor that allows plugin developers to define servlet filters.
|
class |
ServletModuleDescriptor
A module descriptor that allows plugin developers to define servlets.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DownloadStrategyModuleDescriptor
A plugin module which provides a
DownloadStrategy. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultPluginModuleTracker<M,T extends ModuleDescriptor<M>>
Tracks enabled plugin module descriptors, focusing on fast reads
|
interface |
PluginModuleTracker<M,T extends ModuleDescriptor<M>>
Tracks enabled plugin module descriptors, focusing on fast reads.
|
static interface |
PluginModuleTracker.Customizer<M,T extends ModuleDescriptor<M>>
Implement this to customize how and which descriptors are stored
|
| Modifier and Type | Method and Description |
|---|---|
static <M,T extends ModuleDescriptor<M>> |
DefaultPluginModuleTracker.create(PluginAccessor pluginAccessor,
PluginEventManager pluginEventManager,
Class<? extends ModuleDescriptor<?>> moduleDescriptorClass)
Static factory method for constructing trackers generically where M is not known.
|
| Modifier and Type | Method and Description |
|---|---|
static <M,T extends ModuleDescriptor<M>> |
DefaultPluginModuleTracker.create(PluginAccessor pluginAccessor,
PluginEventManager pluginEventManager,
Class<? extends ModuleDescriptor<?>> moduleDescriptorClass)
Static factory method for constructing trackers generically where M is not known.
|
Copyright © 2019 Atlassian. All rights reserved.