com.atlassian.plugin.servlet.descriptors
Class ServletContextParamModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Void>
      com.atlassian.plugin.servlet.descriptors.ServletContextParamModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<java.lang.Void>, Resourced, StateAware

public class ServletContextParamModuleDescriptor
extends AbstractModuleDescriptor<java.lang.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

plugin, resources, singleton

Constructor Summary

ServletContextParamModuleDescriptor()

Method Summary

java.lang.Void	getModule() The particular module object created by this plugin.
java.lang.String	getParamName()
java.lang.String	getParamValue()
void	init(Plugin plugin, org.dom4j.Element element) Initialise a module given it's parent plugin and the XML element representing the module.
protected void	provideValidationRules(ValidationPattern pattern) Provides validation rules for the pattern

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletContextParamModuleDescriptor

public ServletContextParamModuleDescriptor()

Method Detail

init

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

Description copied from interface: ModuleDescriptor

Initialise a module given it's parent plugin and the XML element representing the module.

Since atlassian-plugins v2.2, you can no longer load classes from the plugin in this method, because the OSGi bundle that they will live in is not built yet. Load classes in the AbstractModuleDescriptor.enabled() method instead.

Specified by:

init in interface ModuleDescriptor<java.lang.Void>

Overrides:

init in class AbstractModuleDescriptor<java.lang.Void>

Parameters:

plugin - The plugin that the module belongs to.

element - XML element representing the module.

Throws:

PluginParseException - Can be thrown if an error occurs while parsing the XML element.

provideValidationRules

protected void provideValidationRules(ValidationPattern pattern)

Description copied from class: AbstractModuleDescriptor

Provides validation rules for the pattern

Overrides:

provideValidationRules in class AbstractModuleDescriptor<java.lang.Void>

Parameters:

pattern - The validation pattern

getParamName

public java.lang.String getParamName()

getParamValue

public java.lang.String getParamValue()

getModule

public java.lang.Void getModule()

Description copied from interface: ModuleDescriptor

The particular module object created by this plugin.

Specified by:

getModule in interface ModuleDescriptor<java.lang.Void>

Specified by:

getModule in class AbstractModuleDescriptor<java.lang.Void>

Returns:

The module object created by this plugin.

See Also:

ModuleDescriptor.getModuleClass()