server/componentmanager/Component.java

/* 
 * i-scream central monitoring system
 * Copyright (C) 2000-2002 i-scream
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.componentmanager;

//---IMPORTS---

/**
 * This interface should be implemented by any independent
 * components of the system.  It presents a management
 * interface for all i-scream components.
 *
 * @author  $Author: tdb $
 * @version $Id: Component.java,v 1.6 2001/05/29 17:02:34 tdb Exp $
 */
public interface Component {

//---FINAL ATTRIBUTES---

//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    /**
     * This method starts the implementing component
     */
    public void start() throws ComponentStartException;
    
    /**
     * Does a dependency check. Used mainly at startup to
     * see if the required dependencies (components) are up
     * and running.
     *
     * @return a boolean value, true if the depdencies are satisfied
     */
    public boolean depCheck();
    
//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---

//---STATIC ATTRIBUTES---

}

Revision:	1.7
Committed:	Sat May 18 18:16:01 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.6:	+21 -2 lines
Log Message:	i-scream is now licensed under the GPL. I've added the GPL headers to every source file, and put a full copy of the license in the appropriate places. I think I've covered everything. This is going to be a mad commit ;)
#	Content
1	/*
2	* i-scream central monitoring system
3	* Copyright (C) 2000-2002 i-scream
4	*
5	* This program is free software; you can redistribute it and/or
6	* modify it under the terms of the GNU General Public License
7	* as published by the Free Software Foundation; either version 2
8	* of the License, or (at your option) any later version.
9	*
10	* This program is distributed in the hope that it will be useful,
11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	* GNU General Public License for more details.
14	*
15	* You should have received a copy of the GNU General Public License
16	* along with this program; if not, write to the Free Software
17	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18	*/
19
20	//---PACKAGE DECLARATION---
21	package uk.org.iscream.cms.server.componentmanager;
22
23	//---IMPORTS---
24
25	/**
26	* This interface should be implemented by any independent
27	* components of the system. It presents a management
28	* interface for all i-scream components.
29	*
30	* @author $Author: tdb $
31	* @version $Id: Component.java,v 1.6 2001/05/29 17:02:34 tdb Exp $
32	*/
33	public interface Component {
34
35	//---FINAL ATTRIBUTES---
36
37	//---STATIC METHODS---
38
39	//---CONSTRUCTORS---
40
41	//---PUBLIC METHODS---
42
43	/**
44	* This method starts the implementing component
45	*/
46	public void start() throws ComponentStartException;
47
48	/**
49	* Does a dependency check. Used mainly at startup to
50	* see if the required dependencies (components) are up
51	* and running.
52	*
53	* @return a boolean value, true if the depdencies are satisfied
54	*/
55	public boolean depCheck();
56
57	//---PRIVATE METHODS---
58
59	//---ACCESSOR/MUTATOR METHODS---
60
61	//---ATTRIBUTES---
62
63	//---STATIC ATTRIBUTES---
64
65	}
66