com.taggercat.util
Interface Plugin


public interface Plugin

The interface for Tagger Cat Plug-ins. Implement this interface to create your own plug-in classes. Plug-ins are classes to be loaded at application initialization.

Steps for installing a Plug-in:

  1. Create a class that implements this interface.
  2. Register the plug-in within the servlet section of the application deployment descriptor. Use a name prefix of "plug-in." in the <param-name> element.
    <servlet id="orderProcess">
          .....
            <init-param>
               <param-name>plug-in.MyPlugin</param-name>
               <param-value>sdi.util.MyPlugin</param-value>
            </init-param>
          .....
          </servlet>
  3. Make your implementation class available to your applciation's class path as you would with any other class.

When your application is started, an instance of your plug-in class will be created, and its init() method will be called.

 

Method Summary
 void destroy()
          Called after the owning servlet has been taken out of service.
 boolean init(javax.servlet.ServletContext servletContext)
          Called to initialize the plugin.
 

Method Detail

init

boolean init(javax.servlet.ServletContext servletContext)
Called to initialize the plugin.

Parameters:
servletContext - the ServletContext object
Returns:
return true to have the Configuration object keep a reference to your plug-in class.

destroy

void destroy()
Called after the owning servlet has been taken out of service.