public class

ServletContextParamModuleDescriptor

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

Class Overview

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

Summary

[Expand]

Inherited Fields

From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

Public Constructors
	ServletContextParamModuleDescriptor()

Public Methods
Void	getModule() The particular module object created by this plugin.
String	getParamName()
String	getParamValue()
void	init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module.

Protected Methods
void	provideValidationRules(ValidationPattern pattern) Provides validation rules for the pattern

[Expand]

Inherited Methods

From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

From class java.lang.Object

From interface com.atlassian.plugin.ModuleDescriptor

abstract void	destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed.
abstract String	getCompleteKey() The complete key for this module, including the plugin key.
abstract String	getDescription() A simple description of this descriptor.
abstract String	getDescriptionKey() Key used to override `getDescription()` when using internationalisation.
abstract String	getI18nNameKey() Key used to override `getName()` when using internationalisation.
abstract String	getKey() The key for this module, unique within the plugin.
abstract Float	getMinJavaVersion()
abstract T	getModule() The particular module object created by this plugin.
abstract Class<T>	getModuleClass() The class of the module this descriptor creates.
abstract String	getName() A simple string name for this descriptor.
abstract Map<String, String>	getParams()
abstract Plugin	getPlugin()
abstract String	getPluginKey() The plugin key for this module, derived from the complete key.
abstract void	init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module.
abstract boolean	isEnabledByDefault() Whether or not this plugin module is enabled by default.
abstract boolean	isSystemModule() Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.
abstract boolean	satisfiesMinJavaVersion() If a min java version has been specified this will return true if the running jvm is >= to the specified version.

From interface com.atlassian.plugin.Resourced

From interface com.atlassian.plugin.StateAware

Public Constructors

public ServletContextParamModuleDescriptor ()

Public Methods

public Void getModule ()

The particular module object created by this plugin.

Returns

The module object created by this plugin.

public String getParamName ()

public String getParamValue ()

public void init (Plugin plugin, Element element)

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 enabled() method instead.

Parameters

plugin	The plugin that the module belongs to. Must not be null.
element	XML element representing the module. Must not be null.

Throws

PluginParseException

Protected Methods

protected void provideValidationRules (ValidationPattern pattern)

Provides validation rules for the pattern

Parameters

pattern	The validation pattern

Classes

ServletContextParamModuleDescriptor

Class Overview

Summary

Public Constructors

public ServletContextParamModuleDescriptor ()

Public Methods

public Void getModule ()

Returns

public String getParamName ()

public String getParamValue ()

public void init (Plugin plugin, Element element)

Parameters

Throws

Protected Methods

protected void provideValidationRules (ValidationPattern pattern)

Parameters