com.atlassian.plugin.descriptors.servlet
Class ServletModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      com.atlassian.plugin.descriptors.servlet.ServletModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor, Resourced, StateAware

public abstract class ServletModuleDescriptor
extends AbstractModuleDescriptor
implements StateAware

Field Summary

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

plugin, resources, singleton

Constructor Summary

ServletModuleDescriptor()

Method Summary

protected abstract void	autowireObject(java.lang.Object obj) Autowire an object.
void	disabled() Called by the plugin manager when the module is deactivated.
void	enabled() Called by the plugin manager when the module is activated.
java.util.Map	getInitParams()
java.lang.Object	getModule() The particular module object created by this plugin.
java.util.List	getPaths()
javax.servlet.http.HttpServlet	getServlet()
protected abstract ServletModuleManager	getServletModuleManager() Retrieve the ServletModuleManager class from your container framework.
void	init(Plugin plugin, org.dom4j.Element element) Initialise a module given it's parent plugin and the XML element representing the module.

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

assertModuleClassImplements, destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServletModuleDescriptor

public ServletModuleDescriptor()

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.

Specified by:

init in interface ModuleDescriptor

Overrides:

init in class AbstractModuleDescriptor

Throws:

PluginParseException

enabled

public void enabled()

Description copied from interface: StateAware

Called by the plugin manager when the module is activated. Modules that are active when the plugin manager is initialised will have this method called at that time.

Specified by:

enabled in interface StateAware

disabled

public void disabled()

Description copied from interface: StateAware

Called by the plugin manager when the module is deactivated. This method will only be called if the plugin is deactivated while the application is running: stopping the server will not cause this method to be called on any plugins.

Specified by:

disabled in interface StateAware

getModule

public java.lang.Object getModule()

Description copied from interface: ModuleDescriptor

The particular module object created by this plugin.

Specified by:

getModule in interface ModuleDescriptor

Specified by:

getModule in class AbstractModuleDescriptor

getServlet

public javax.servlet.http.HttpServlet getServlet()

getPaths

public java.util.List getPaths()

getInitParams

public java.util.Map getInitParams()

autowireObject

protected abstract void autowireObject(java.lang.Object obj)

Autowire an object. Implement this in your IoC framework or simply do nothing.

getServletModuleManager

protected abstract ServletModuleManager getServletModuleManager()

Retrieve the ServletModuleManager class from your container framework.