Changeset 5407


Ignore:
Timestamp:
Sep 13, 2010, 12:53:20 PM (12 years ago)
Author:
Nicklas Nordborg
Message:

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

Location:
trunk/doc/src
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/developerdoc/plugin_developer.xml

    r5071 r5407  
    661661                parameter is used to tell the core if the plug-in was successful or
    662662                failed. Not setting a response is considered a failure by the core. From
    663                 the run method it is only allowed to use the
    664                 <methodname>Response.setDone()</methodname>
    665                 or the
    666                 <methodname>Response.setError()</methodname>
     663                the run method it is only allowed to use on of the
     664                <methodname>Response.setDone()</methodname>,
     665                <methodname>Response.setError()</methodname> or
     666                <methodname>Response.setContinue()</methodname>
    667667                methods.
    668668              </para>
     
    17531753          designed for. This method should not throw any exceptions.
    17541754          Use the <methodname>Response.setDone()</methodname>
    1755           method to report success or the <methodname>Response.setError()</methodname>
    1756           to report errors.
     1755          method to report success, the <methodname>Response.setError()</methodname>
     1756          method to report errors or the <methodname>Response.setContinue()</methodname>
     1757          method to respond to a shutdown signal and tell the core to resume the
     1758          job once the system is up and running again.
    17571759          </para>
    17581760        </listitem>
     
    17601762        <listitem>
    17611763          <para>
    1762           In both cases the <methodname>Plugin.done()</methodname>
     1764          In all cases the <methodname>Plugin.done()</methodname>
    17631765          method is called and the plug-in instance is discarded.
    17641766          </para>
     
    47604762   
    47614763    <para>
    4762       Another signal handler implementation is the
    4763       <classname docapi="net.sf.basedb.core.signal">ProgressReporterSignalHandler</classname>.
    4764       See that javadoc for information about how to use it.
    4765       For more information about the signalling system as a whole,
    4766       see <xref linkend="core_api.signals" />.
     4764      Other signal handler implementations are
     4765      <classname docapi="net.sf.basedb.core.signal">ProgressReporterSignalHandler</classname>
     4766      and <classname docapi="net.sf.basedb.core.signal">EnhancedThreadSignalHandler</classname>.
     4767      The latter handler also has support for the <constant>SHUTDOWN</constant> signal
     4768      which is sent to plug-in when the system is shutting down. Clever plug-ins may use
     4769      this to enable them to be restarted when the system is up and running again.
     4770      See that javadoc for information about how to use it. For more information about the
     4771      signalling system as a whole, see <xref linkend="core_api.signals" />.
    47674772    </para>
    47684773   
Note: See TracChangeset for help on using the changeset viewer.