public class

DefaultModuleDescriptorFactory

extends Object
implements ModuleDescriptorFactory
java.lang.Object
   ↳ com.atlassian.plugin.DefaultModuleDescriptorFactory

Class Overview

Default implementation of a descriptor factory that allows filtering of descriptor keys

Summary

Public Constructors
@Deprecated DefaultModuleDescriptorFactory()
This constructor is deprecated. Since 2.2.0, use DefaultModuleDescriptorFactory(HostContainer) instead
DefaultModuleDescriptorFactory(HostContainer hostContainer)
Instantiates a descriptor factory that uses the host container to create descriptors
Public Methods
void addModuleDescriptor(String type, Class<? extends ModuleDescriptor> moduleDescriptorClass)
ModuleDescriptor<?> getModuleDescriptor(String type)
Class<? extends ModuleDescriptor> getModuleDescriptorClass(String type)
boolean hasModuleDescriptor(String type)
void removeModuleDescriptorForType(String type)
void setModuleDescriptors(Map<StringString> moduleDescriptorClassNames)
void setPermittedModuleKeys(List<String> permittedModuleKeys)
Sets the list of module keys that will be loaded.
Protected Methods
Map<StringClass<? extends ModuleDescriptor>> getDescriptorClassesMap()
boolean shouldSkipModuleOfType(String type)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.plugin.ModuleDescriptorFactory

Public Constructors

@Deprecated public DefaultModuleDescriptorFactory ()

This constructor is deprecated.
Since 2.2.0, use DefaultModuleDescriptorFactory(HostContainer) instead

public DefaultModuleDescriptorFactory (HostContainer hostContainer)

Instantiates a descriptor factory that uses the host container to create descriptors

Parameters
hostContainer The host container implementation for descriptor creation

Public Methods

public void addModuleDescriptor (String type, Class<? extends ModuleDescriptor> moduleDescriptorClass)

public Class<? extends ModuleDescriptor> getModuleDescriptorClass (String type)

public boolean hasModuleDescriptor (String type)

public void removeModuleDescriptorForType (String type)

public void setModuleDescriptors (Map<StringString> moduleDescriptorClassNames)

public void setPermittedModuleKeys (List<String> permittedModuleKeys)

Sets the list of module keys that will be loaded. If this list is empty, then the factory will permit all recognised module types to load. This allows you to run the plugin system in a 'restricted mode'

Parameters
permittedModuleKeys List of (String) keys

Protected Methods

protected Map<StringClass<? extends ModuleDescriptor>> getDescriptorClassesMap ()

protected boolean shouldSkipModuleOfType (String type)