com.atlassian.plugin.servlet.descriptors
Class BaseServletModuleDescriptor<T>

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

All Implemented Interfaces:

ModuleDescriptor<T>, Resourced, StateAware

Direct Known Subclasses:

ServletFilterModuleDescriptor, ServletModuleDescriptor

public abstract class BaseServletModuleDescriptor<T>
extends AbstractModuleDescriptor<T>

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.

Since:

2.1.0

Field Summary

protected static org.slf4j.Logger

log

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

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

Constructor Summary

BaseServletModuleDescriptor(ModuleFactory moduleCreator)

Method Summary

Map<String,String>	getInitParams()
List<String>	getPaths()
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, getModule, 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

Field Detail

log

protected static final org.slf4j.Logger log

Constructor Detail

BaseServletModuleDescriptor

public BaseServletModuleDescriptor(ModuleFactory moduleCreator)

Parameters:

moduleCreator -

Since:

2.5.0

Method Detail

init

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

Specified by:

init in interface ModuleDescriptor<T>

Overrides:

init in class AbstractModuleDescriptor<T>

Throws:

PluginParseException

provideValidationRules

protected void provideValidationRules(ValidationPattern pattern)

Overrides:

provideValidationRules in class AbstractModuleDescriptor<T>

getPaths

public List<String> getPaths()

getInitParams

public Map<String,String> getInitParams()