Interface IRequestListenerPlugin


  • public interface IRequestListenerPlugin
    This interface represents a plug-in listener. Implement this class to add the listener to an ARequestNotifier of a subsystem.

    Version:
    $Revision$, $Date$
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] getConfigParams()
      get the configuration parameters of the plug-in.
      IConfigStore getConfigStore()
      get the configuration store of the plugin where the configuration parameters of the plug-in are stored.
      java.lang.String getImplName()
      get the plugin implementaion name set in the init() method.
      java.lang.String getName()
      get the registered class name set in the init() method.
      void init​(java.lang.String name, java.lang.String implName, IConfigStore config)
      the subsystem call this method to initialize the plug-in.
      void shutdown()
      shutdown the plugin.
    • Method Detail

      • getName

        java.lang.String getName()
        get the registered class name set in the init() method.

        Returns:
        the Name.
      • getImplName

        java.lang.String getImplName()
        get the plugin implementaion name set in the init() method.

        Returns:
        the plugin implementation name.
      • init

        void init​(java.lang.String name,
                  java.lang.String implName,
                  IConfigStore config)
           throws EBaseException
        the subsystem call this method to initialize the plug-in.

        Parameters:
        name - the registered class name of the plug-in.
        implName - the implemetnation name of the plug-in.
        config - the configuration store where the. properties of the plug-in are stored.
        Throws:
        EBaseException - throws base exception in the certificate server.
      • shutdown

        void shutdown()
        shutdown the plugin.
      • getConfigParams

        java.lang.String[] getConfigParams()
                                    throws EBaseException
        get the configuration parameters of the plug-in.

        Returns:
        the configuration parameters.
        Throws:
        EBaseException - throws base exception in the certificate server.
      • getConfigStore

        IConfigStore getConfigStore()
        get the configuration store of the plugin where the configuration parameters of the plug-in are stored.

        Returns:
        the configuration store.