public abstract class

BaseServletModuleDescriptor

extends AbstractModuleDescriptor<T>
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor<T>
Known Direct Subclasses

Class Overview

Acts as a base for other servlet type module descriptors to inherit. It adds parsing and retrieval of any paths declared in the descriptor with <url-pattern> as well as <init-param>s.

Summary

Fields
protected static final Logger log
[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
BaseServletModuleDescriptor()
This constructor is deprecated. Since 2.5.0, use BaseServletModuleDescriptor( com.atlassian.plugin.module.ModuleFactory ) instead (as of 2.5.0).
BaseServletModuleDescriptor(ModuleFactory moduleCreator)
Public Methods
Map<String, String> getInitParams()
List<String> getPaths()
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
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware

Fields

protected static final Logger log

Public Constructors

public BaseServletModuleDescriptor ()

This constructor is deprecated.
Since 2.5.0, use BaseServletModuleDescriptor( com.atlassian.plugin.module.ModuleFactory ) instead (as of 2.5.0).

public BaseServletModuleDescriptor (ModuleFactory moduleCreator)

Public Methods

public Map<String, String> getInitParams ()

public List<String> getPaths ()

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