org.apache.struts.action

Interface PlugIn

Known Implementing Classes:
DigestingPlugIn, ModuleConfigVerifier, TilesPlugin, ValidatorPlugIn

public interface PlugIn

A PlugIn is a configuration wrapper for a module-specific resource or service that needs to be notified about application startup and application shutdown events (corresponding to when the container calls init and destroy on the corresponding ActionServlet instance). PlugIn objects can be configured in the struts-config.xml file, without the need to subclass ActionServlet simply to perform application lifecycle activities.

Implementations of this interface must supply a zero-argument constructor for use by ActionServlet. Configuration can be accomplished by providing standard JavaBeans property setter methods, which will all have been called before the init() method is invoked.

This interface can be applied to any class, including an Action subclass

Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
Since:
Struts 1.1

Method Summary

void
destroy()
Receive notification that our owning module is being shut down.
void
init(ActionServlet servlet, ModuleConfig config)
Receive notification that the specified module is being started up.

Method Details

destroy

public void destroy()
Receive notification that our owning module is being shut down.

init

public void init(ActionServlet servlet,
                 ModuleConfig config)
            throws ServletException
Receive notification that the specified module is being started up.
Parameters:
servlet - ActionServlet that is managing all the modules in this web application
config - ModuleConfig for the module with which this plug-in is associated

Copyright B) 2000-2007 - The Apache Software Foundation