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, 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, singleton

Constructor Summary

ServletContextParamModuleDescriptor()

Method Summary

Void	getModule()
String	getParamName()
String	getParamValue()
void	init(Plugin plugin, org.dom4j.Element element)
protected void	provideValidationRules(ValidationPattern pattern)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletContextParamModuleDescriptor

public ServletContextParamModuleDescriptor()

Method Detail

init

public void init(Plugin plugin,
                 org.dom4j.Element element)
          throws PluginParseException

Specified by:

init in interface ModuleDescriptor<Void>

Overrides:

init in class AbstractModuleDescriptor<Void>

Throws:

PluginParseException

provideValidationRules

protected void provideValidationRules(ValidationPattern pattern)

Overrides:

provideValidationRules 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>