Changeset 5407 for trunk/doc/src/docbook/developerdoc/plugin_developer.xml

Timestamp:

Sep 13, 2010, 12:53:20 PM (13 years ago)

Author:

Nicklas Nordborg

Message:

References #1509, #1503 and #1502. Updated documentation related to the mentioned tickets.

File:

• trunk/doc/src/docbook/developerdoc/plugin_developer.xml (modified) (4 diffs)

trunk/doc/src/docbook/developerdoc/plugin_developer.xml

@@ -661 +661 @@
                 parameter is used to tell the core if the plug-in was successful or
                 failed. Not setting a response is considered a failure by the core. From
-                the run method it is only allowed to use the
-                <methodname>Response.setDone()</methodname>
-                or the
-                <methodname>Response.setError()</methodname>
+                the run method it is only allowed to use on of the
+                <methodname>Response.setDone()</methodname>,
+                <methodname>Response.setError()</methodname> or 
+                <methodname>Response.setContinue()</methodname>
                 methods.
               </para>
@@ -1753 +1753 @@
           designed for. This method should not throw any exceptions.
           Use the <methodname>Response.setDone()</methodname>
-          method to report success or the <methodname>Response.setError()</methodname>
-          to report errors.
+          method to report success, the <methodname>Response.setError()</methodname>
+          method to report errors or the <methodname>Response.setContinue()</methodname>
+          method to respond to a shutdown signal and tell the core to resume the
+          job once the system is up and running again.
           </para>
         </listitem>
@@ -1760 +1762 @@
         <listitem>
           <para>
-          In both cases the <methodname>Plugin.done()</methodname>
+          In all cases the <methodname>Plugin.done()</methodname>
           method is called and the plug-in instance is discarded.
           </para>
@@ -4760 +4762 @@
     
     <para>
-      Another signal handler implementation is the
-      <classname docapi="net.sf.basedb.core.signal">ProgressReporterSignalHandler</classname>.
-      See that javadoc for information about how to use it.
-      For more information about the signalling system as a whole,
-      see <xref linkend="core_api.signals" />.
+      Other signal handler implementations are
+      <classname docapi="net.sf.basedb.core.signal">ProgressReporterSignalHandler</classname>
+      and <classname docapi="net.sf.basedb.core.signal">EnhancedThreadSignalHandler</classname>.
+      The latter handler also has support for the <constant>SHUTDOWN</constant> signal
+      which is sent to plug-in when the system is shutting down. Clever plug-ins may use
+      this to enable them to be restarted when the system is up and running again.
+      See that javadoc for information about how to use it. For more information about the 
+      signalling system as a whole, see <xref linkend="core_api.signals" />.
     </para>