Uses of Interface
com.atlassian.plugin.ModuleDescriptor

Packages that use ModuleDescriptor

Package	Description
com.atlassian.plugin
com.atlassian.plugin.descriptors
com.atlassian.plugin.event.events	This package contains events that will be fired by the framework.
com.atlassian.plugin.eventlistener.descriptors
com.atlassian.plugin.impl
com.atlassian.plugin.manager
com.atlassian.plugin.metadata
com.atlassian.plugin.module
com.atlassian.plugin.osgi.external
com.atlassian.plugin.osgi.factory	Deployers for OSGi-related plugins
com.atlassian.plugin.osgi.factory.descriptor
com.atlassian.plugin.osgi.module
com.atlassian.plugin.parsers
com.atlassian.plugin.predicate
com.atlassian.plugin.schema.impl
com.atlassian.plugin.servlet.descriptors
com.atlassian.plugin.servlet.download.plugin
com.atlassian.plugin.tracker

Uses of ModuleDescriptor in com.atlassian.plugin

Methods in com.atlassian.plugin with type parameters of type ModuleDescriptor

Modifier and Type	Method and Description
<D extends ModuleDescriptor<?>> List<D>	PluginAccessor.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz) Get all enabled module descriptors that have a specific descriptor class.
<D extends ModuleDescriptor<?>> List<D>	PluginAccessor.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz, boolean verbose) Deprecated. Since 2.3.0, use #getEnabledModuleDescriptorsByClass(Class) instead

Methods in com.atlassian.plugin that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	PluginAccessor.getEnabledPluginModule(String completeKey) Retrieve an enabled plugin module by complete module key.
ModuleDescriptor<?>	DummyPlugin.getModuleDescriptor(String key)
ModuleDescriptor<?>	DefaultModuleDescriptorFactory.getModuleDescriptor(String type)
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.

Methods in com.atlassian.plugin that return types with arguments of type ModuleDescriptor

Modifier and Type	Method and Description
protected Map<String,Class<? extends ModuleDescriptor>>	DefaultModuleDescriptorFactory.getDescriptorClassesMap()
<M> List<ModuleDescriptor<M>>	PluginAccessor.getEnabledModuleDescriptorsByType(String type) Deprecated. since 0.17, use PluginAccessor.getModuleDescriptors(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
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.
<M> Collection<ModuleDescriptor<M>>	PluginAccessor.getModuleDescriptors(ModuleDescriptorPredicate<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.

Methods in com.atlassian.plugin with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
void	DummyPlugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)
void	Plugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)

Method parameters in com.atlassian.plugin with type arguments of type ModuleDescriptor

Modifier and Type	Method and Description
void	DefaultModuleDescriptorFactory.addModuleDescriptor(String type, Class<? extends ModuleDescriptor> moduleDescriptorClass)
<M> List<M>	PluginAccessor.getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>> descriptorClass, Class<M> moduleClass) Deprecated. since 0.17, use PluginAccessor.getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.

Uses of ModuleDescriptor in com.atlassian.plugin.descriptors

Classes in com.atlassian.plugin.descriptors that implement ModuleDescriptor

Modifier and Type	Class and Description
class	AbstractModuleDescriptor<T>
class	ResourcedModuleDescriptor<T> Deprecated. All module descriptors now have resources. Use AbstractModuleDescriptor instead.
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

Methods in com.atlassian.plugin.descriptors that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	ChainModuleDescriptorFactory.getModuleDescriptor(String type)

Methods in com.atlassian.plugin.descriptors that return types with arguments of type ModuleDescriptor

Modifier and Type	Method and Description
Class<? extends ModuleDescriptor>	ChainModuleDescriptorFactory.getModuleDescriptorClass(String type)

Methods in com.atlassian.plugin.descriptors with parameters of type ModuleDescriptor

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.

Uses of ModuleDescriptor in com.atlassian.plugin.event.events

Methods in com.atlassian.plugin.event.events that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	PluginModuleUnavailableEvent.getModule()
ModuleDescriptor<?>	PluginModuleEnabledEvent.getModule()
ModuleDescriptor	PluginModuleAvailableEvent.getModule()
ModuleDescriptor<?>	BeforePluginModuleDisabledEvent.getModule()
ModuleDescriptor<?>	PluginModuleDisabledEvent.getModule()

Constructors in com.atlassian.plugin.event.events with parameters of type ModuleDescriptor

Constructor and Description
BeforePluginModuleDisabledEvent(ModuleDescriptor<?> module, boolean persistent)
PluginModuleAvailableEvent(ModuleDescriptor module)
PluginModuleDisabledEvent(ModuleDescriptor<?> module, boolean persistent)
PluginModuleEnabledEvent(ModuleDescriptor<?> module)
PluginModuleUnavailableEvent(ModuleDescriptor<?> module)

Uses of ModuleDescriptor in com.atlassian.plugin.eventlistener.descriptors

Classes in com.atlassian.plugin.eventlistener.descriptors that implement ModuleDescriptor

Modifier and Type	Class and Description
class	EventListenerModuleDescriptor

Uses of ModuleDescriptor in com.atlassian.plugin.impl

Methods in com.atlassian.plugin.impl that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	AbstractPlugin.getModuleDescriptor(String key)
ModuleDescriptor<?>	AbstractDelegatingPlugin.getModuleDescriptor(String key)

Methods in com.atlassian.plugin.impl that return types with arguments of type ModuleDescriptor

Modifier and Type	Method and Description
Collection<ModuleDescriptor<?>>	AbstractPlugin.getModuleDescriptors() Returns the module descriptors for this plugin
Collection<ModuleDescriptor<?>>	AbstractDelegatingPlugin.getModuleDescriptors()
<M> List<ModuleDescriptor<M>>	AbstractDelegatingPlugin.getModuleDescriptorsByModuleClass(Class<M> moduleClass)
<T> List<ModuleDescriptor<T>>	AbstractPlugin.getModuleDescriptorsByModuleClass(Class<T> aClass)

Methods in com.atlassian.plugin.impl with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
void	AbstractPlugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)
void	AbstractDelegatingPlugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)

Uses of ModuleDescriptor in com.atlassian.plugin.manager

Methods in com.atlassian.plugin.manager with type parameters of type ModuleDescriptor

Modifier and Type	Method and Description
<D extends ModuleDescriptor<?>> List<D>	EnabledModuleCachingPluginAccessor.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)
<D extends ModuleDescriptor<?>> List<D>	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<?>> List<D>	DefaultPluginManager.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz, boolean verbose)

Methods in com.atlassian.plugin.manager that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	DefaultPluginManager.getEnabledPluginModule(String completeKey)
ModuleDescriptor<?>	DefaultPluginManager.getPluginModule(String completeKey)

Methods in com.atlassian.plugin.manager that return types with arguments of type ModuleDescriptor

Modifier and Type	Method and Description
<M> List<ModuleDescriptor<M>>	DefaultPluginManager.getEnabledModuleDescriptorsByType(String type) Deprecated. since 0.17, use DefaultPluginManager.getModuleDescriptors(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
<M> Collection<ModuleDescriptor<M>>	DefaultPluginManager.getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)

Methods in com.atlassian.plugin.manager with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
protected void	DefaultPluginManager.disablePluginModuleState(ModuleDescriptor<?> module, PluginPersistentStateStore stateStore)
protected void	DefaultPluginManager.enablePluginModuleState(ModuleDescriptor<?> module, PluginPersistentStateStore stateStore)
boolean	DefaultPluginPersistentState.isEnabled(ModuleDescriptor<?> pluginModule)
boolean	PluginPersistentState.isEnabled(ModuleDescriptor<?> pluginModule) Whether or not a given plugin module is enabled in this state, calculated from it's current state AND default state.
protected void	DefaultPluginManager.notifyModuleDisabled(ModuleDescriptor<?> module)
protected void	DefaultPluginManager.notifyModuleEnabled(ModuleDescriptor<?> module)
PluginPersistentState.Builder	PluginPersistentState.Builder.setEnabled(ModuleDescriptor<?> pluginModule, boolean isEnabled)

Method parameters in com.atlassian.plugin.manager with type arguments of type ModuleDescriptor

Modifier and Type	Method and Description
<M> List<M>	DefaultPluginManager.getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>> descriptorClass, Class<M> moduleClass) Deprecated. since 0.17, use DefaultPluginManager.getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.

Constructor parameters in com.atlassian.plugin.manager with type arguments of type ModuleDescriptor

Constructor and Description
EnabledModuleCachingPluginAccessor(PluginAccessor delegate, PluginEventManager pluginEventManager, ConcurrentCacheFactory<Class<ModuleDescriptor<Object>>,PluginModuleTracker<Object,ModuleDescriptor<Object>>> pluginModuleTrackerCacheFactory)
EnabledModuleCachingPluginAccessor(PluginAccessor delegate, PluginEventManager pluginEventManager, ConcurrentCacheFactory<Class<ModuleDescriptor<Object>>,PluginModuleTracker<Object,ModuleDescriptor<Object>>> pluginModuleTrackerCacheFactory)

Uses of ModuleDescriptor in com.atlassian.plugin.metadata

Methods in com.atlassian.plugin.metadata with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
boolean	PluginMetadataManager.isOptional(ModuleDescriptor<?> moduleDescriptor) This is used to determine if a module is considered optional.
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	ClasspathFilePluginMetadata.required(ModuleDescriptor<?> module)

Uses of ModuleDescriptor in com.atlassian.plugin.module

Methods in com.atlassian.plugin.module with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
<T> T	PrefixDelegatingModuleFactory.createModule(String className, 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> T	HostContainerLegacyAdaptor.createModule(String name, ModuleDescriptor<T> moduleDescriptor)
<T> T	ClassPrefixModuleFactory.createModule(String name, ModuleDescriptor<T> moduleDescriptor)
<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

Uses of ModuleDescriptor in com.atlassian.plugin.osgi.external

Classes in com.atlassian.plugin.osgi.external with type parameters of type ModuleDescriptor

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.

Methods in com.atlassian.plugin.osgi.external that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor	SingleModuleDescriptorFactory.getModuleDescriptor(String type)

Methods in com.atlassian.plugin.osgi.external that return types with arguments of type ModuleDescriptor

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()

Uses of ModuleDescriptor in com.atlassian.plugin.osgi.factory

Methods in com.atlassian.plugin.osgi.factory that return ModuleDescriptor

Modifier and Type	Method and Description
protected ModuleDescriptor<?>	OsgiPluginXmlDescriptorParser.createModuleDescriptor(Plugin plugin, org.dom4j.Element element, ModuleDescriptorFactory moduleDescriptorFactory) Passes module descriptor elements back to the OsgiPlugin

Methods in com.atlassian.plugin.osgi.factory that return types with arguments of type ModuleDescriptor

Modifier and Type	Method and Description
Class<? extends ModuleDescriptor<?>>	UnavailableModuleDescriptorRequiringRestartFallbackFactory.getModuleDescriptorClass(String type)

Uses of ModuleDescriptor in com.atlassian.plugin.osgi.factory.descriptor

Classes in com.atlassian.plugin.osgi.factory.descriptor that implement ModuleDescriptor

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.

Methods in com.atlassian.plugin.osgi.factory.descriptor that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	ModuleTypeModuleDescriptor.getModule()

Uses of ModuleDescriptor in com.atlassian.plugin.osgi.module

Methods in com.atlassian.plugin.osgi.module with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
<T> T	BeanPrefixModuleFactory.createModule(String name, ModuleDescriptor<T> moduleDescriptor)

Uses of ModuleDescriptor in com.atlassian.plugin.parsers

Methods in com.atlassian.plugin.parsers that return ModuleDescriptor

Modifier and Type	Method and Description
protected ModuleDescriptor<?>	XmlDescriptorParser.createModuleDescriptor(Plugin plugin, org.dom4j.Element element, ModuleDescriptorFactory moduleDescriptorFactory)

Uses of ModuleDescriptor in com.atlassian.plugin.predicate

Methods in com.atlassian.plugin.predicate with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
boolean	ModulePredicate.matches(ModuleDescriptor moduleDescriptor) Deprecated. Will match a plugin module according to implementation rules.
boolean	EnabledModulePredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor)
boolean	ModuleOfClassPredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor)
boolean	ModuleDescriptorOfClassPredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor)
boolean	ModuleDescriptorPredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor) Will match a plugin module according to implementation rules.

Constructor parameters in com.atlassian.plugin.predicate with type arguments of type ModuleDescriptor

Constructor and Description
ModuleDescriptorOfClassPredicate(Class<? extends ModuleDescriptor<? extends T>> moduleDescriptorClass)

Uses of ModuleDescriptor in com.atlassian.plugin.schema.impl

Classes in com.atlassian.plugin.schema.impl that implement ModuleDescriptor

Modifier and Type	Class and Description
class	DescribedModuleTypeModuleDescriptor Descriptor that allows described module descriptor factories to be configured in XML.

Methods in com.atlassian.plugin.schema.impl that return types with arguments of type ModuleDescriptor

Modifier and Type	Method and Description
Set<Class<? extends ModuleDescriptor>>	DefaultDescribedModuleDescriptorFactory.getModuleDescriptorClasses()

Uses of ModuleDescriptor in com.atlassian.plugin.servlet.descriptors

Classes in com.atlassian.plugin.servlet.descriptors that implement ModuleDescriptor

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.

Uses of ModuleDescriptor in com.atlassian.plugin.servlet.download.plugin

Classes in com.atlassian.plugin.servlet.download.plugin that implement ModuleDescriptor

Modifier and Type	Class and Description
class	DownloadStrategyModuleDescriptor A plugin module which provides a DownloadStrategy.

Uses of ModuleDescriptor in com.atlassian.plugin.tracker

Classes in com.atlassian.plugin.tracker with type parameters of type ModuleDescriptor

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

Methods in com.atlassian.plugin.tracker with type parameters of type ModuleDescriptor

Modifier and Type	Method and Description
static <M,T extends ModuleDescriptor<M>> PluginModuleTracker<M,T>	DefaultPluginModuleTracker.create(PluginAccessor pluginAccessor, PluginEventManager pluginEventManager, Class<? extends ModuleDescriptor<?>> moduleDescriptorClass) Static factory method for constructing trackers generically where M is not known.

Method parameters in com.atlassian.plugin.tracker with type arguments of type ModuleDescriptor

Modifier and Type	Method and Description
static <M,T extends ModuleDescriptor<M>> PluginModuleTracker<M,T>	DefaultPluginModuleTracker.create(PluginAccessor pluginAccessor, PluginEventManager pluginEventManager, Class<? extends ModuleDescriptor<?>> moduleDescriptorClass) Static factory method for constructing trackers generically where M is not known.