com.atlassian.plugin.servlet.descriptors

Class ServletModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor<javax.servlet.http.HttpServlet>

com.atlassian.plugin.servlet.descriptors.ServletModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<javax.servlet.http.HttpServlet>, Resourced, StateAware

public class ServletModuleDescriptor
extends BaseServletModuleDescriptor<javax.servlet.http.HttpServlet>
implements StateAware

A module descriptor that allows plugin developers to define servlets. Developers can define what urls the servlet should be serve by defining one or more <url-pattern> elements.

Field Summary

Fields inherited from class com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor

log

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

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

Constructor Summary

Constructors

Constructor and Description
ServletModuleDescriptor(ModuleFactory moduleFactory, ServletModuleManager servletModuleManager) Creates a descriptor that uses a module factory to create instances

Method Summary

Modifier and Type	Method and Description
void	disabled()
void	enabled()
javax.servlet.http.HttpServlet	getModule()
javax.servlet.http.HttpServlet	getServlet() Deprecated. Since 2.0.0, use getModule()

Methods inherited from class com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor

getInitParams, getPaths, init, provideValidationRules

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletModuleDescriptor

public ServletModuleDescriptor(ModuleFactory moduleFactory,
                               ServletModuleManager servletModuleManager)

Creates a descriptor that uses a module factory to create instances

Parameters:

moduleFactory -

Since:

2.5.0

Method Detail

enabled

public void enabled()

Specified by:

enabled in interface StateAware

Overrides:

enabled in class AbstractModuleDescriptor<javax.servlet.http.HttpServlet>

disabled

public void disabled()

Specified by:

disabled in interface StateAware

Overrides:

disabled in class AbstractModuleDescriptor<javax.servlet.http.HttpServlet>

getModule

public javax.servlet.http.HttpServlet getModule()

Specified by:

getModule in interface ModuleDescriptor<javax.servlet.http.HttpServlet>

Specified by:

getModule in class AbstractModuleDescriptor<javax.servlet.http.HttpServlet>

getServlet

@Deprecated
public javax.servlet.http.HttpServlet getServlet()

Deprecated. Since 2.0.0, use getModule()