Daemon.java

  1. /*
  2.  * Copyright (c) 2002-2022, City of Paris
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  *  1. Redistributions of source code must retain the above copyright notice
  10.  *     and the following disclaimer.
  11.  *
  12.  *  2. Redistributions in binary form must reproduce the above copyright notice
  13.  *     and the following disclaimer in the documentation and/or other materials
  14.  *     provided with the distribution.
  15.  *
  16.  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
  17.  *     contributors may be used to endorse or promote products derived from
  18.  *     this software without specific prior written permission.
  19.  *
  20.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21.  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  24.  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25.  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26.  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27.  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28.  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30.  * POSSIBILITY OF SUCH DAMAGE.
  31.  *
  32.  * License 1.0
  33.  */
  34. package fr.paris.lutece.portal.service.daemon;

  36. /**
  37.  * Interfaces for Daemons Service.
  38.  */
  39. public abstract class Daemon implements Runnable
  40. {
  41.     // //////////////////////////////////////////////////////////////////////////////
  42.     // Constants
  43.     public static final int STATUS_STOPPED = 0;
  44.     public static final int STATUS_RUNNING = 1;

  46.     /** The result for this daemon is not yet known. */
  47.     public static final int RESULT_UNKNOWN = 0;

  49.     /** A daemon has processed and it was successful */
  50.     public static final int RESULT_SUCCESS = 1;

  52.     /** A daemon has processed but it has failed */
  53.     public static final int RESULT_FAILED = 2;

  55.     /** A daemon is processing so its result is not yet known */
  56.     public static final int RESULT_PROCESSING = 3;
  57.     private StringBuilder _sbLastRunLogs;
  58.     private int _nResult;
  59.     private String _strPluginName;

  61.     /**
  62.      * Gets the plugin name
  63.      *
  64.      * @return the plugin name
  65.      */
  66.     public String getPluginName( )
  67.     {
  68.         return _strPluginName;
  69.     }

  71.     /**
  72.      * Sets the plugin name
  73.      *
  74.      * @param pluginName
  75.      *            The plugin name
  76.      */
  77.     public void setPluginName( String pluginName )
  78.     {
  79.         _strPluginName = pluginName;
  80.     }

  82.     /**
  83.      * Returns the LastRunLogs
  84.      *
  85.      * @return The LastRunLogs
  86.      */
  87.     public String getLastRunLogs( )
  88.     {
  89.         return ( _sbLastRunLogs != null ?_sbLastRunLogs.toString( ) : "" );
  90.     }

  92.     /**
  93.      * Sets the LastRunLogs
  94.      *
  95.      * @param strLastRunLogs
  96.      *            The LastRunLogs
  97.      */
  98.     public void setLastRunLogs( String strLastRunLogs )
  99.     {
  100.         _sbLastRunLogs = new StringBuilder( strLastRunLogs ) ;
  101.     }

  103.     /**
  104.      * Append to LastRunLogs
  105.      *
  106.      * @param strLastRunLogsPart
  107.      *            The LastRunLogs part
  108.      */
  109.     public void appendLastRunLogs( String strLastRunLogsPart )
  110.     {
  111.         if ( _sbLastRunLogs == null )
  112.         {
  113.             _sbLastRunLogs = new StringBuilder( strLastRunLogsPart ) ;
  114.         }
  115.         else
  116.         {
  117.             _sbLastRunLogs.append( strLastRunLogsPart ) ;
  118.         }
  119.         
  120.     }

  122.     /**
  123.      * Returns the Result
  124.      *
  125.      * @return The Result
  126.      */
  127.     public int getResult( )
  128.     {
  129.         return _nResult;
  130.     }

  132.     /**
  133.      * Sets the Result
  134.      *
  135.      * @param nResult
  136.      *            The Result
  137.      */
  138.     public void setResult( int nResult )
  139.     {
  140.         _nResult = nResult;
  141.     }

  143.     /**
  144.      * Stop the daemon. Clean up allocated resources
  145.      */
  146.     protected void stop( )
  147.     {
  148.         // nothing by default
  149.     }
  150. }
Created with JaCoCo 0.8.4.201905082037