org.dmd.dmp.server.servlet.base.plugins

Class BasicActionManagerPlugin

java.lang.Object

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

org.dmd.dmp.server.servlet.base.plugins.BasicActionManagerPlugin

All Implemented Interfaces:

Runnable, ActionManagerIF

public class BasicActionManagerPlugin
extends DmpServletPlugin
implements Runnable, ActionManagerIF

The BasicActionManagerPlugin provides an extensible mechanism for adding action support to your application. Unlike basic CRUD mechanisms, actions are inherently asynchronous and take a nondeterministic amount of time to complete. Application specific plug-ins can register derivatives of the ActionFactory to instantiate ActionImplementation derivatives that perform the actual behaviour associated with the action.

Field Summary

Fields inherited from class org.dmd.dmp.server.servlet.base.DmpServletPlugin

cache, pluginConfig, pluginManager, servlet

Constructor Summary

Constructors

Constructor and Description
BasicActionManagerPlugin()

Method Summary

Modifier and Type	Method and Description
void	actionComplete(ActionHandler actionHandler) Again, this method can be used by an "action handler wrapper" to notify the action manager when an action handler exits its run() method normally.
void	actionFailed(ActionHandler actionHandler, Exception ex) An action handler has thrown an exception (which it shouldn't really).
void	init() Derived classes should perform any initialization logic required.
void	preInit()
void	registerAction(ActionFactory<?,?> factory) Registers a factory for a particular action trigger.
void	run()
void	shutdown() When the servlet is destroyed, the shutdown() method is called on all plugins.
void	start() After all plugins are initialized, the start method is called on all plugins in the same implied order.

Methods inherited from class org.dmd.dmp.server.servlet.base.DmpServletPlugin

getID, getPluginName, setManagerAndConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicActionManagerPlugin

public BasicActionManagerPlugin()

Method Detail

registerAction

public void registerAction(ActionFactory<?,?> factory)
                    throws org.dmd.util.exceptions.ResultException

Description copied from interface: ActionManagerIF

Registers a factory for a particular action trigger.

Specified by:

registerAction in interface ActionManagerIF

Parameters:

factory - the factory that creates handlers for the action

Throws:

org.dmd.util.exceptions.ResultException - if we already have a registered handle for the action

actionFailed

public void actionFailed(ActionHandler actionHandler,
                         Exception ex)

An action handler has thrown an exception (which it shouldn't really). So we'll send a final error response on its behalf.

Specified by:

actionFailed in interface ActionManagerIF

Parameters:

actionHandler - the action handler that failed.

ex - the exception that was caught.

actionComplete

public void actionComplete(ActionHandler actionHandler)

Description copied from interface: ActionManagerIF

Again, this method can be used by an "action handler wrapper" to notify the action manager when an action handler exits its run() method normally. The action manager can then perform cleanup if required.

Specified by:

actionComplete in interface ActionManagerIF

preInit

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

Overrides:

preInit in class DmpServletPlugin

Throws:

org.dmd.util.exceptions.ResultException

org.dmd.dmc.DmcValueException

init

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

Description copied from class: DmpServletPlugin

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.

Overrides:

init in class DmpServletPlugin

Throws:

org.dmd.dmc.rules.DmcRuleExceptionSet

org.dmd.dmc.DmcNameClashException

org.dmd.util.exceptions.ResultException

org.dmd.dmc.DmcValueException

start

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

Description copied from class: DmpServletPlugin

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

Overrides:

start in class DmpServletPlugin

Throws:

org.dmd.util.exceptions.ResultException

org.dmd.dmc.DmcValueException

shutdown

public void shutdown()

Description copied from class: DmpServletPlugin

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

Overrides:

shutdown in class DmpServletPlugin

run

public void run()

Specified by:

run in interface Runnable