Package com.atlassian.plugin.descriptors

Class AbstractModuleDescriptor<T>

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

All Implemented Interfaces:

ModuleDescriptor<T>, Resourced, ScopeAware, StateAware

Direct Known Subclasses:

EventListenerModuleDescriptor, UnloadableModuleDescriptor, UnrecognisedModuleDescriptor

public abstract class AbstractModuleDescriptor<T>
extends Object
implements ModuleDescriptor<T>, StateAware

Field Summary

Fields

Modifier and Type	Field	Description
protected String	key
protected Class<T>	moduleClass
protected String	moduleClassName
protected final ModuleFactory	moduleFactory
protected String	name
protected Plugin	plugin
protected Resources	resources

Constructor Summary

Constructors

Constructor	Description
AbstractModuleDescriptor(ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method	Description
protected final void	assertModuleClassImplements(Class<T> requiredModuleClazz)	Check that the module class of this descriptor implements a given interface, or extends a given class.
protected final void	checkPermissions()	This is a method that module should call (in their init method implementation to check that permissions are correctly set on the plugin.
void	destroy()	The default implementation disables the module if it's still enabled, and unreference the plugin.
void	disabled()	Disables the module descriptor.
void	enabled()	Enables the descriptor by loading the module class.
boolean	equals(Object obj)
String	getCompleteKey()
String	getDescription()
String	getDescriptionKey()
String	getI18nNameKey()
String	getKey()
Float	getMinJavaVersion()
abstract T	getModule()
Class<T>	getModuleClass()
protected String	getModuleClassName()
String	getName()
Map<String,String>	getParams()
Plugin	getPlugin()
String	getPluginKey()
protected Set<String>	getRequiredPermissions()	The set of additionally required permissions.
ResourceDescriptor	getResourceDescriptor(String type, String name)
List<ResourceDescriptor>	getResourceDescriptors()
ResourceLocation	getResourceLocation(String type, String name)
Optional<String>	getScopeKey()
int	hashCode()
void	init(Plugin plugin, Element element)
boolean	isBroken()
boolean	isEnabled()	Get whether this plugin module is enabled.
boolean	isEnabledByDefault()
boolean	isSystemModule()
protected void	loadClass(Plugin plugin, String clazz)	Loads the module class that this descriptor provides, and will not necessarily be the implementation class.
boolean	satisfiesMinJavaVersion()
void	setBroken()
void	setPlugin(Plugin plugin)	Sets the plugin for the ModuleDescriptor
String	toString()
protected void	validate(Element element)	Validates the element has the key attribute present Provides validation for given element

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName

Field Details

plugin

protected Plugin plugin

key

protected String key

name

protected String name

moduleClassName

protected String moduleClassName

moduleClass

protected Class<T> moduleClass

resources

protected Resources resources

moduleFactory

protected final ModuleFactory moduleFactory

Constructor Details

AbstractModuleDescriptor

public AbstractModuleDescriptor(ModuleFactory moduleFactory)

Method Details

init

public void init(@Nonnull
 Plugin plugin,
 @Nonnull
 Element element)

Specified by:

init in interface ModuleDescriptor<T>

checkPermissions

protected final void checkPermissions()

This is a method that module should call (in their init method implementation to check that permissions are correctly set on the plugin. Use the RequirePermission annotation to add permissions to a module, and/or getRequiredPermissions() if you need more dynamic permissions. If either all permissions are allowed or this is a system module, we don't bother to check permissions

Throws:

ModulePermissionException - if the plugin doesn't require the necessary permissions for the module to work.

Since:

3.0

See Also:

• RequirePermission
• getRequiredPermissions()

getRequiredPermissions

protected Set<String> getRequiredPermissions()

The set of additionally required permissions. This is useful for dynamic permissions depending on module configuration. One might prefer the RequirePermission annotation otherwise for 'static' permissions.

Default implementation returns an empty set

Returns:

the set of additionally required permissions.

Since:

3.0

See Also:

• RequirePermission
• checkPermissions()

validate

protected void validate(Element element)

Validates the element has the key attribute present Provides validation for given element

Parameters:

element - The element to validate

Since:

7.5.0

loadClass

protected void loadClass(Plugin plugin,
 String clazz)

Loads the module class that this descriptor provides, and will not necessarily be the implementation class. Override this for module descriptors whose type cannot be determined via generics.

Parameters:

clazz - The module class name to load

Throws:

IllegalStateException - If the module class cannot be determined and the descriptor doesn't define a module type via generics

destroy

public void destroy()

The default implementation disables the module if it's still enabled, and unreference the plugin. Override this if your plugin needs to clean up when it's been removed, and call super.destroy(Plugin) before returning.

Specified by:

destroy in interface ModuleDescriptor<T>

isEnabledByDefault

public boolean isEnabledByDefault()

Specified by:

isEnabledByDefault in interface ModuleDescriptor<T>

isSystemModule

public boolean isSystemModule()

Specified by:

isSystemModule in interface ModuleDescriptor<T>

assertModuleClassImplements

protected final void assertModuleClassImplements(Class<T> requiredModuleClazz)

Check that the module class of this descriptor implements a given interface, or extends a given class.

Parameters:

requiredModuleClazz - The class this module's class must implement or extend.

Throws:

PluginParseException - If the module class does not implement or extend the given class.

getCompleteKey

public String getCompleteKey()

Specified by:

getCompleteKey in interface ModuleDescriptor<T>

getPluginKey

public String getPluginKey()

Specified by:

getPluginKey in interface ModuleDescriptor<T>

getKey

public String getKey()

Specified by:

getKey in interface ModuleDescriptor<T>

getName

public String getName()

Specified by:

getName in interface ModuleDescriptor<T>

getModuleClass

public Class<T> getModuleClass()

Specified by:

getModuleClass in interface ModuleDescriptor<T>

getModule

public abstract T getModule()

Specified by:

getModule in interface ModuleDescriptor<T>

getScopeKey

public Optional<String> getScopeKey()

Specified by:

getScopeKey in interface ScopeAware

getDescription

public String getDescription()

Specified by:

getDescription in interface ModuleDescriptor<T>

getParams

public Map<String,String> getParams()

Specified by:

getParams in interface ModuleDescriptor<T>

getI18nNameKey

public String getI18nNameKey()

Specified by:

getI18nNameKey in interface ModuleDescriptor<T>

getDescriptionKey

public String getDescriptionKey()

Specified by:

getDescriptionKey in interface ModuleDescriptor<T>

getResourceDescriptors

public List<ResourceDescriptor> getResourceDescriptors()

Specified by:

getResourceDescriptors in interface Resourced

getResourceLocation

public ResourceLocation getResourceLocation(String type,
 String name)

Specified by:

getResourceLocation in interface Resourced

getResourceDescriptor

public ResourceDescriptor getResourceDescriptor(String type,
 String name)

Specified by:

getResourceDescriptor in interface Resourced

getMinJavaVersion

public Float getMinJavaVersion()

Specified by:

getMinJavaVersion in interface ModuleDescriptor<T>

satisfiesMinJavaVersion

public boolean satisfiesMinJavaVersion()

Specified by:

satisfiesMinJavaVersion in interface ModuleDescriptor<T>

setPlugin

public void setPlugin(Plugin plugin)

Sets the plugin for the ModuleDescriptor

Parameters:

plugin - The plugin to set for this descriptor.

getPlugin

public Plugin getPlugin()

Specified by:

getPlugin in interface ModuleDescriptor<T>

Returns:

The plugin this module descriptor is associated with.

equals

public boolean equals(Object obj)

Specified by:

equals in interface ModuleDescriptor<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface ModuleDescriptor<T>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

enabled

public void enabled()

Enables the descriptor by loading the module class. Classes overriding this method MUST call super.enabled() before their own enabling code.

Specified by:

enabled in interface StateAware

Since:

2.1.0

disabled

public void disabled()

Disables the module descriptor. Classes overriding this method MUST call super.disabled() after their own disabling code.

Specified by:

disabled in interface StateAware

getModuleClassName

protected String getModuleClassName()

Returns:

The defined module class name

Since:

3.0

isEnabled

public boolean isEnabled()

Get whether this plugin module is enabled.

Specified by:

isEnabled in interface ModuleDescriptor<T>

Returns:

If this module is enabled

Since:

3.1

setBroken

public void setBroken()

Specified by:

setBroken in interface ModuleDescriptor<T>

isBroken

public boolean isBroken()

Specified by:

isBroken in interface ModuleDescriptor<T>