src/org/sonews/daemon/AbstractDaemon.java
author cli
Wed, 14 Sep 2011 12:54:40 +0200
changeset 60 39f1fadf50a0
parent 37 74139325d305
permissions -rwxr-xr-x
Add libcommons-codec-java to Debian dependencies.
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
cli@37
    35
	/** This variable is write synchronized through setRunning */
cli@37
    36
	private boolean isRunning = false;
chris@1
    37
cli@37
    38
	/**
cli@37
    39
	 * Protected constructor. Will be called by derived classes.
cli@37
    40
	 */
cli@37
    41
	protected AbstractDaemon()
cli@37
    42
	{
cli@37
    43
		setDaemon(true); // VM will exit when all threads are daemons
cli@37
    44
		setName(getClass().getSimpleName());
cli@37
    45
	}
cli@37
    46
cli@37
    47
	/**
cli@37
    48
	 * @return true if shutdown() was not yet called.
cli@37
    49
	 */
cli@37
    50
	public boolean isRunning()
cli@37
    51
	{
cli@37
    52
		synchronized (this) {
cli@37
    53
			return this.isRunning;
cli@37
    54
		}
cli@37
    55
	}
cli@37
    56
cli@37
    57
	/**
cli@37
    58
	 * Marks this thread to exit soon. Closes the associated JDBCDatabase connection
cli@37
    59
	 * if available.
cli@37
    60
	 * @throws java.sql.SQLException
cli@37
    61
	 */
cli@37
    62
	public void shutdownNow()
cli@37
    63
		throws SQLException
cli@37
    64
	{
cli@37
    65
		synchronized (this) {
cli@37
    66
			this.isRunning = false;
cli@37
    67
			StorageManager.disableProvider();
cli@37
    68
		}
cli@37
    69
	}
cli@37
    70
cli@37
    71
	/**
cli@37
    72
	 * Calls shutdownNow() but catches SQLExceptions if occurring.
cli@37
    73
	 */
cli@37
    74
	public void shutdown()
cli@37
    75
	{
cli@37
    76
		try {
cli@37
    77
			shutdownNow();
cli@37
    78
		} catch (SQLException ex) {
cli@37
    79
			Log.get().warning(ex.toString());
cli@37
    80
		}
cli@37
    81
	}
cli@37
    82
cli@37
    83
	/**
cli@37
    84
	 * Starts this daemon.
cli@37
    85
	 */
cli@37
    86
	@Override
cli@37
    87
	public void start()
cli@37
    88
	{
cli@37
    89
		synchronized (this) {
cli@37
    90
			this.isRunning = true;
cli@37
    91
		}
cli@37
    92
		super.start();
cli@37
    93
	}
chris@1
    94
}