org/sonews/daemon/AbstractDaemon.java
author cli
Thu Aug 20 16:57:38 2009 +0200 (2009-08-20)
changeset 14 efce4ec25564
parent 1 6fceb66e1ad7
child 15 f2293e8566f5
permissions -rw-r--r--
Fix #548: API change; changed parameter type of Storage.getGroupsForList()
chris@1
     1
/*
chris@1
     2
 *   SONEWS News Server
chris@1
     3
 *   see AUTHORS for the list of contributors
chris@1
     4
 *
chris@1
     5
 *   This program is free software: you can redistribute it and/or modify
chris@1
     6
 *   it under the terms of the GNU General Public License as published by
chris@1
     7
 *   the Free Software Foundation, either version 3 of the License, or
chris@1
     8
 *   (at your option) any later version.
chris@1
     9
 *
chris@1
    10
 *   This program is distributed in the hope that it will be useful,
chris@1
    11
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
chris@1
    12
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
chris@1
    13
 *   GNU General Public License for more details.
chris@1
    14
 *
chris@1
    15
 *   You should have received a copy of the GNU General Public License
chris@1
    16
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
chris@1
    17
 */
chris@1
    18
chris@1
    19
package org.sonews.daemon;
chris@1
    20
chris@1
    21
import java.sql.SQLException;
chris@3
    22
import org.sonews.storage.StorageManager;
chris@1
    23
import org.sonews.util.Log;
chris@1
    24
chris@1
    25
/**
chris@1
    26
 * Base class of all sonews threads.
chris@1
    27
 * Instances of this class will be automatically registered at the ShutdownHook
chris@1
    28
 * to be cleanly exited when the server is forced to exit.
chris@1
    29
 * @author Christian Lins
chris@1
    30
 * @since sonews/0.5.0
chris@1
    31
 */
chris@1
    32
public abstract class AbstractDaemon extends Thread
chris@1
    33
{
chris@1
    34
chris@1
    35
  /** This variable is write synchronized through setRunning */
chris@1
    36
  private boolean isRunning = false;
chris@1
    37
chris@1
    38
  /**
chris@1
    39
   * Protected constructor. Will be called by derived classes.
chris@1
    40
   */
chris@1
    41
  protected AbstractDaemon()
chris@1
    42
  {
chris@1
    43
    setDaemon(true); // VM will exit when all threads are daemons
chris@1
    44
    setName(getClass().getSimpleName());
chris@1
    45
  }
chris@1
    46
  
chris@1
    47
  /**
chris@1
    48
   * @return true if shutdown() was not yet called.
chris@1
    49
   */
chris@1
    50
  public boolean isRunning()
chris@1
    51
  {
chris@1
    52
    synchronized(this)
chris@1
    53
    {
chris@1
    54
      return this.isRunning;
chris@1
    55
    }
chris@1
    56
  }
chris@1
    57
  
chris@1
    58
  /**
chris@3
    59
   * Marks this thread to exit soon. Closes the associated JDBCDatabase connection
chris@1
    60
   * if available.
chris@1
    61
   * @throws java.sql.SQLException
chris@1
    62
   */
chris@3
    63
  public void shutdownNow()
chris@1
    64
    throws SQLException
chris@1
    65
  {
chris@1
    66
    synchronized(this)
chris@1
    67
    {
chris@1
    68
      this.isRunning = false;
chris@3
    69
      StorageManager.disableProvider();
chris@1
    70
    }
chris@1
    71
  }
chris@1
    72
  
chris@1
    73
  /**
chris@1
    74
   * Calls shutdownNow() but catches SQLExceptions if occurring.
chris@1
    75
   */
chris@1
    76
  public void shutdown()
chris@1
    77
  {
chris@1
    78
    try
chris@1
    79
    {
chris@1
    80
      shutdownNow();
chris@1
    81
    }
chris@1
    82
    catch(SQLException ex)
chris@1
    83
    {
chris@1
    84
      Log.msg(ex, true);
chris@1
    85
    }
chris@1
    86
  }
chris@1
    87
  
chris@1
    88
  /**
chris@1
    89
   * Starts this daemon.
chris@1
    90
   */
chris@1
    91
  @Override
chris@1
    92
  public void start()
chris@1
    93
  {
chris@1
    94
    synchronized(this)
chris@1
    95
    {
chris@1
    96
      this.isRunning = true;
chris@1
    97
    }
chris@1
    98
    super.start();
chris@1
    99
  }
chris@1
   100
  
chris@1
   101
}