server/filter/PluginServiceCheck.java

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

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

/**
 * An interface to which a Plugin for a Service Check must adhere.
 *
 * @author  $Author: tdb1 $
 * @version $Id: PluginServiceCheck.java,v 1.2 2001/02/12 00:34:11 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.3
Committed:	Wed Mar 14 23:25:29 2001 UTC (23 years, 2 months ago) by tdb
Branch:	MAIN
CVS Tags:	PROJECT_COMPLETION
Changes since 1.2:	+4 -4 lines
Log Message:	The whole server package structure has been changed. Old Package: uk.ac.ukc.iscream.* New Package: uk.org.iscream.*
#	User	Rev	Content
1	ajm	1.1	//---PACKAGE DECLARATION---
2	tdb	1.3	package uk.org.iscream.filter;
3	ajm	1.1
4			//---IMPORTS---
5	tdb	1.3	import uk.org.iscream.util.XMLPacket;
6	ajm	1.1
7			/**
8			* An interface to which a Plugin for a Service Check must adhere.
9			*
10	tdb	1.3	* @author $Author: tdb1 $
11			* @version $Id: PluginServiceCheck.java,v 1.2 2001/02/12 00:34:11 tdb1 Exp $
12	ajm	1.1	*/
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	tdb	1.2	* @param hostname the hostname to run the checks on
26			* @return the XML containing results from the check
27	ajm	1.1	*/
28			public String runServiceCheck(String hostname);
29
30
31			/**
32	tdb	1.2	* Return a String representation of what the plugin service
33			* check does (e.g. "Checks the xxx service is running on host")
34	ajm	1.1	*
35			* @return the description
36			*/
37			public String getDescription();
38
39			//---PRIVATE METHODS---
40
41			//---ACCESSOR/MUTATOR METHODS---
42
43			}