ServletModuleDescriptor

extends BaseServletModuleDescriptor<T>
implements StateAware

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

Class Overview

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.

Summary

[Expand]

Inherited Fields

From class com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor

From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

Public Constructors
	ServletModuleDescriptor(ModuleFactory moduleFactory, ServletModuleManager servletModuleManager) Creates a descriptor that uses a module factory to create instances

Public Methods
void	disabled() Disables the module descriptor.
void	enabled() Enables the descriptor by loading the module class.
HttpServlet	getModule() The particular module object created by this plugin.
@Deprecated HttpServlet	getServlet() This method is deprecated. Since 2.0.0, use `getModule()`

[Expand]

Inherited Methods

From class com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor

From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

From class java.lang.Object

From interface com.atlassian.plugin.ModuleDescriptor

void	destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed.
boolean	equals(Object obj) Compares the specified object with this module descriptor for equality.
String	getCompleteKey() The complete key for this module, including the plugin key.
String	getDescription() A simple description of this descriptor.
String	getDescriptionKey() Key used to override `getDescription()` when using internationalisation.
String	getI18nNameKey() Key used to override `getName()` when using internationalisation.
String	getKey() The key for this module, unique within the plugin.
Float	getMinJavaVersion()
T	getModule() The particular module object created by this plugin.
Class<T>	getModuleClass() The class of the module this descriptor creates.
String	getName() A simple string name for this descriptor.
Map<String, String>	getParams()
Plugin	getPlugin()
String	getPluginKey() The plugin key for this module, derived from the complete key.
int	hashCode() Returns the hash code value for this module descriptor.
void	init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module.
boolean	isEnabledByDefault() Whether or not this plugin module is enabled by default.
boolean	isSystemModule() Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.
boolean	satisfiesMinJavaVersion() If a min java version has been specified this will return true if the running jvm is >= to the specified version.

From interface com.atlassian.plugin.Resourced

From interface com.atlassian.plugin.StateAware

Public Constructors

public ServletModuleDescriptor (ModuleFactory moduleFactory, ServletModuleManager servletModuleManager)

Creates a descriptor that uses a module factory to create instances

Public Methods

public void disabled ()

Disables the module descriptor. Classes overriding this method MUST call super.disabled() after their own disabling code.

public void enabled ()

Enables the descriptor by loading the module class. Classes overriding this method MUST call super.enabled() before their own enabling code.

public HttpServlet getModule ()

The particular module object created by this plugin.

Returns

The module object created by this plugin.

@Deprecated public HttpServlet getServlet ()

This method is deprecated.
Since 2.0.0, use getModule()