server/componentmanager/Component.java

//---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: tdb1 $
 * @version $Id: Component.java,v 1.5 2001/03/14 23:25:29 tdb1 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.6
Committed:	Tue May 29 17:02:34 2001 UTC (22 years, 11 months ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.5:	+2 -2 lines
Log Message:	Major change in the java package naming. This has been held off for some time now, but it really needed doing. The future packaging of all i-scream products will be; uk.org.iscream.<product>.<subpart>.* In the case of the central monitoring system server this will be; uk.org.iscream.cms.server.* The whole server has been changed to follow this structure, and tested to a smallish extent. Further changes in other parts of the CMS will follow.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.org.iscream.cms.server.componentmanager;
3
4	//---IMPORTS---
5
6	/**
7	* This interface should be implemented by any independent
8	* components of the system. It presents a management
9	* interface for all i-scream components.
10	*
11	* @author $Author: tdb1 $
12	* @version $Id: Component.java,v 1.5 2001/03/14 23:25:29 tdb1 Exp $
13	*/
14	public interface Component {
15
16	//---FINAL ATTRIBUTES---
17
18	//---STATIC METHODS---
19
20	//---CONSTRUCTORS---
21
22	//---PUBLIC METHODS---
23
24	/**
25	* This method starts the implementing component
26	*/
27	public void start() throws ComponentStartException;
28
29	/**
30	* Does a dependency check. Used mainly at startup to
31	* see if the required dependencies (components) are up
32	* and running.
33	*
34	* @return a boolean value, true if the depdencies are satisfied
35	*/
36	public boolean depCheck();
37
38	//---PRIVATE METHODS---
39
40	//---ACCESSOR/MUTATOR METHODS---
41
42	//---ATTRIBUTES---
43
44	//---STATIC ATTRIBUTES---
45
46	}
47