View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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;
35  
36  
37  /**
38   * Interfaces for Daemons Service.
39   */
40  public abstract class Daemon implements Runnable
41  {
42      ////////////////////////////////////////////////////////////////////////////////
43      // Constants
44      public static final int STATUS_STOPPED = 0;
45      public static final int STATUS_RUNNING = 1;
46  
47      /** The result for this daemon is not yet known. */
48      public static final int RESULT_UNKNOWN = 0;
49  
50      /** A daemon has processed and it was successful */
51      public static final int RESULT_SUCCESS = 1;
52  
53      /** A daemon has processed but it has failed */
54      public static final int RESULT_FAILED = 2;
55  
56      /** A daemon is processing so its result is not yet known */
57      public static final int RESULT_PROCESSING = 3;
58      private String _strLastRunLogs;
59      private int _nResult;
60      private String _strPluginName;
61  
62      /**
63       * Gets the plugin name
64       *
65       * @return the plugin name
66       */
67      public String getPluginName(  )
68      {
69          return _strPluginName;
70      }
71  
72      /**
73       * Sets the plugin name
74       *
75       * @param pluginName The plugin name
76       */
77      public void setPluginName( String pluginName )
78      {
79          _strPluginName = pluginName;
80      }
81  
82      /**
83       * Returns the LastRunLogs
84       *
85       * @return The LastRunLogs
86       */
87      public String getLastRunLogs(  )
88      {
89          return _strLastRunLogs;
90      }
91  
92      /**
93       * Sets the LastRunLogs
94       *
95       * @param strLastRunLogs The LastRunLogs
96       */
97      public void setLastRunLogs( String strLastRunLogs )
98      {
99          _strLastRunLogs = strLastRunLogs;
100     }
101 
102     /**
103      * Returns the Result
104      *
105      * @return The Result
106      */
107     public int getResult(  )
108     {
109         return _nResult;
110     }
111 
112     /**
113      * Sets the Result
114      *
115      * @param nResult The Result
116      */
117     public void setResult( int nResult )
118     {
119         _nResult = nResult;
120     }
121 }