org.dmd.dmp.server.servlet.base

Class DmpServletPlugin

java.lang.Object

org.dmd.dmp.server.servlet.base.DmpServletPlugin

Direct Known Subclasses:

BasicActionManagerPlugin, BasicCachePlugin, BasicRequestTrackerPlugin, BasicSecurityPlugin, SecurityPlugin

public class DmpServletPlugin
extends Object

The DmpServletPlugin class is an abstract base from which all plugins used in the DMP Servlet Reference Implementation must be derived. Plugins have a defined life cycle that includes:

• pre-initialization: allows for addition of schemas associated with your functionality and the addition of indices to the cache.
• initialization: at this stage, the cache has been loaded with any existing persisted objects and plugins can perform additional object creations and any other required initialization
• starting: plugins are called on to start before we actually begin servicing client requests
• stopping: called when the servlet is being shutdown.

Field Summary

Fields

Modifier and Type	Field and Description
protected CacheIF	cache
protected PluginConfig	pluginConfig
protected PluginManager	pluginManager
protected DMPServiceImpl	servlet

Constructor Summary

Constructors

Constructor and Description
DmpServletPlugin()

Method Summary

Modifier and Type	Method and Description
int	getID()
String	getPluginName()
protected void	init() Derived classes should perform any initialization logic required.
protected void	preInit()
protected void	setManagerAndConfig(PluginManager pm, PluginConfig c)
protected void	shutdown() When the servlet is destroyed, the shutdown() method is called on all plugins.
protected void	start() After all plugins are initialized, the start method is called on all plugins in the same implied order.

Methods inherited from class java.lang.Object

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

Field Detail

pluginConfig

protected PluginConfig pluginConfig

pluginManager

protected PluginManager pluginManager

servlet

protected DMPServiceImpl servlet

cache

protected CacheIF cache

Constructor Detail

DmpServletPlugin

public DmpServletPlugin()

Method Detail

getPluginName

public String getPluginName()

getID

public int getID()

Returns:

the plugin's unique ID.

setManagerAndConfig

protected void setManagerAndConfig(PluginManager pm,
                                   PluginConfig c)

preInit

protected void preInit()
                throws org.dmd.util.exceptions.ResultException,
                       org.dmd.dmc.DmcValueException

Throws:

org.dmd.util.exceptions.ResultException

org.dmd.dmc.DmcValueException

init

protected void init()
             throws org.dmd.util.exceptions.ResultException,
                    org.dmd.dmc.DmcValueException,
                    org.dmd.dmc.rules.DmcRuleExceptionSet,
                    org.dmd.dmc.DmcNameClashException

Derived classes should perform any initialization logic required. If a plugin has indicated that it depends on another plugin, it is safe to assume that the other plugin has been initialized.

Throws:

org.dmd.dmc.rules.DmcRuleExceptionSet

org.dmd.dmc.DmcNameClashException

org.dmd.util.exceptions.ResultException

org.dmd.dmc.DmcValueException

start

protected void start()
              throws org.dmd.util.exceptions.ResultException,
                     org.dmd.dmc.DmcValueException

After all plugins are initialized, the start method is called on all plugins in the same implied order.

Throws:

org.dmd.util.exceptions.ResultException

org.dmd.dmc.DmcValueException

shutdown

protected void shutdown()

When the servlet is destroyed, the shutdown() method is called on all plugins.