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

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

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

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

Constructor Summary

Constructors

Constructor and Description
BaseServletModuleDescriptor(ModuleFactory moduleCreator)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getInitParams()
List<String>	getPaths()
void	init(Plugin plugin, org.dom4j.Element element) Initialise a module given it's parent plugin and the XML element representing the module.
boolean	isAsyncSupported()
protected void	provideValidationRules(ValidationPattern pattern) Provides validation rules for the pattern

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName

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

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

Specified by:

init in interface ModuleDescriptor<T>

Overrides:

init in class AbstractModuleDescriptor<T>

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

Parameters:

pattern - The validation pattern

getPaths

public List<String> getPaths()

getInitParams

public Map<String,String> getInitParams()

isAsyncSupported

public boolean isAsyncSupported()

Since:

4.6.0