com.atlassian.plugin

Class DefaultModuleDescriptorFactory

java.lang.Object

com.atlassian.plugin.DefaultModuleDescriptorFactory

All Implemented Interfaces:

ModuleDescriptorFactory

public class DefaultModuleDescriptorFactory
extends java.lang.Object
implements ModuleDescriptorFactory

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

Constructor Summary

Constructors

Constructor and Description
DefaultModuleDescriptorFactory() Deprecated. Since 2.2.0, use DefaultModuleDescriptorFactory(HostContainer) instead
DefaultModuleDescriptorFactory(HostContainer hostContainer) Instantiates a descriptor factory that uses the host container to create descriptors

Method Summary

Methods

Modifier and Type	Method and Description
void	addModuleDescriptor(java.lang.String type, java.lang.Class<? extends ModuleDescriptor> moduleDescriptorClass)
protected java.util.Map<java.lang.String,java.lang.Class<? extends ModuleDescriptor>>	getDescriptorClassesMap()
ModuleDescriptor<?>	getModuleDescriptor(java.lang.String type)
java.lang.Class<? extends ModuleDescriptor>	getModuleDescriptorClass(java.lang.String type)
boolean	hasModuleDescriptor(java.lang.String type)
void	removeModuleDescriptorForType(java.lang.String type)
void	setModuleDescriptors(java.util.Map<java.lang.String,java.lang.String> moduleDescriptorClassNames)
void	setPermittedModuleKeys(java.util.List<java.lang.String> permittedModuleKeys) Sets the list of module keys that will be loaded.
protected boolean	shouldSkipModuleOfType(java.lang.String type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultModuleDescriptorFactory

@Deprecated
public DefaultModuleDescriptorFactory()

Deprecated. Since 2.2.0, use DefaultModuleDescriptorFactory(HostContainer) instead

DefaultModuleDescriptorFactory

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

Since:

2.2.0

Method Detail

getModuleDescriptorClass

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

Specified by:

getModuleDescriptorClass in interface ModuleDescriptorFactory

getModuleDescriptor

public ModuleDescriptor<?> getModuleDescriptor(java.lang.String type)
                                        throws PluginParseException,
                                               java.lang.IllegalAccessException,
                                               java.lang.InstantiationException,
                                               java.lang.ClassNotFoundException

Specified by:

getModuleDescriptor in interface ModuleDescriptorFactory

Throws:

PluginParseException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.lang.ClassNotFoundException

shouldSkipModuleOfType

protected boolean shouldSkipModuleOfType(java.lang.String type)

setModuleDescriptors

public void setModuleDescriptors(java.util.Map<java.lang.String,java.lang.String> moduleDescriptorClassNames)

hasModuleDescriptor

public boolean hasModuleDescriptor(java.lang.String type)

Specified by:

hasModuleDescriptor in interface ModuleDescriptorFactory

addModuleDescriptor

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

removeModuleDescriptorForType

public void removeModuleDescriptorForType(java.lang.String type)

getDescriptorClassesMap

protected final java.util.Map<java.lang.String,java.lang.Class<? extends ModuleDescriptor>> getDescriptorClassesMap()

setPermittedModuleKeys

public void setPermittedModuleKeys(java.util.List<java.lang.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