Package com.atlassian.plugin.servlet.descriptors

Class ServletContextParamModuleDescriptor

java.lang.Object

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

com.atlassian.plugin.servlet.descriptors.ServletContextParamModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<Void>, Resourced, ScopeAware, StateAware

public class ServletContextParamModuleDescriptor
extends AbstractModuleDescriptor<Void>

Allows plugin developers to specify init parameters they would like added to the plugin local ServletContext.

Since:

2.1.0

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor	Description
ServletContextParamModuleDescriptor()

Method Summary

Modifier and Type	Method	Description
Void	getModule()
String	getParamName()
String	getParamValue()
void	init(Plugin plugin, Element element)
protected void	validate(Element element)

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName

Constructor Details

ServletContextParamModuleDescriptor

public ServletContextParamModuleDescriptor()

Method Details

init

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

Specified by:

init in interface ModuleDescriptor<Void>

Overrides:

init in class AbstractModuleDescriptor<Void>

validate

protected void validate(Element element)

Overrides:

validate in class AbstractModuleDescriptor<Void>

getParamName

public String getParamName()

getParamValue

public String getParamValue()

getModule

public Void getModule()

Specified by:

getModule in interface ModuleDescriptor<Void>

Specified by:

getModule in class AbstractModuleDescriptor<Void>