server/filter/PluginServiceCheck.java

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

//---IMPORTS---
import uk.org.iscream.cms.server.util.XMLPacket;

/**
 * An interface to which a Plugin for a Service Check must adhere.
 *
 * @author  $Author: tdb1 $
 * @version $Id: PluginServiceCheck.java,v 1.3 2001/03/14 23:25:29 tdb1 Exp $
 */
public interface PluginServiceCheck {

//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    /**
     * Performs a check on the service, and returns the
     * XML for the service check
     *
     * @param hostname the hostname to run the checks on
     * @return the XML containing results from the check
     */
    public String runServiceCheck(String hostname);
    
    
    /**
     * Return a String representation of what the plugin service
     * check does (e.g. "Checks the xxx service is running on host")
     *
     * @return the description
     */
    public String getDescription();

//---PRIVATE METHODS---

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

}
Revision:	1.4
Committed:	Tue May 29 17:02:35 2001 UTC (22 years, 11 months ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.3:	+3 -3 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.filter;
3
4	//---IMPORTS---
5	import uk.org.iscream.cms.server.util.XMLPacket;
6
7	/**
8	* An interface to which a Plugin for a Service Check must adhere.
9	*
10	* @author $Author: tdb1 $
11	* @version $Id: PluginServiceCheck.java,v 1.3 2001/03/14 23:25:29 tdb1 Exp $
12	*/
13	public interface PluginServiceCheck {
14
15	//---STATIC METHODS---
16
17	//---CONSTRUCTORS---
18
19	//---PUBLIC METHODS---
20
21	/**
22	* Performs a check on the service, and returns the
23	* XML for the service check
24	*
25	* @param hostname the hostname to run the checks on
26	* @return the XML containing results from the check
27	*/
28	public String runServiceCheck(String hostname);
29
30
31	/**
32	* Return a String representation of what the plugin service
33	* check does (e.g. "Checks the xxx service is running on host")
34	*
35	* @return the description
36	*/
37	public String getDescription();
38
39	//---PRIVATE METHODS---
40
41	//---ACCESSOR/MUTATOR METHODS---
42
43	}