Package 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	Description
protected static final org.slf4j.Logger	log

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

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

Constructor Summary

Constructors

Constructor	Description
BaseServletModuleDescriptor(ModuleFactory moduleCreator)

Method Summary

Modifier and Type	Method	Description
protected boolean	getDefaultAsyncSupported()	Allows subclasses to override the default <async-supported/> setting for this descriptor.
Map<String,String>	getInitParams()
List<String>	getPaths()
void	init(Plugin plugin, Element element)
boolean	isAsyncSupported()
protected void	validate(Element element)

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 Details

log

protected static final org.slf4j.Logger log

Constructor Details

BaseServletModuleDescriptor

public BaseServletModuleDescriptor(ModuleFactory moduleCreator)

Parameters:

moduleCreator - a factory for creating this descriptor's module

Since:

2.5.0

Method Details

init

public void init(@Nonnull
 Plugin plugin,
 @Nonnull
 Element element)

Specified by:

init in interface ModuleDescriptor<T>

Overrides:

init in class AbstractModuleDescriptor<T>

validate

protected void validate(Element element)

Overrides:

validate in class AbstractModuleDescriptor<T>

getPaths

public List<String> getPaths()

getInitParams

public Map<String,String> getInitParams()

isAsyncSupported

public boolean isAsyncSupported()

Since:

4.6.0

getDefaultAsyncSupported

protected boolean getDefaultAsyncSupported()

Allows subclasses to override the default <async-supported/> setting for this descriptor. If a derived class does not override this method, the default will be false.

Note: This method is called by the constructor, so other properties, like AbstractModuleDescriptor.getCompleteKey(), are not available when this runs.

Returns:

false

Since:

5.8.0