server/filter/PluginServiceCheck.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.filter;

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

/**
 * An interface to which a Plugin for a Service Check must adhere.
 *
 * @author  $Author: tdb $
 * @version $Id: PluginServiceCheck.java,v 1.4 2001/05/29 17:02:35 tdb 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.5
Committed:	Sat May 18 18:16:02 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.4:	+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.filter;
22
23	//---IMPORTS---
24	import uk.org.iscream.cms.server.util.XMLPacket;
25
26	/**
27	* An interface to which a Plugin for a Service Check must adhere.
28	*
29	* @author $Author: tdb $
30	* @version $Id: PluginServiceCheck.java,v 1.4 2001/05/29 17:02:35 tdb Exp $
31	*/
32	public interface PluginServiceCheck {
33
34	//---STATIC METHODS---
35
36	//---CONSTRUCTORS---
37
38	//---PUBLIC METHODS---
39
40	/**
41	* Performs a check on the service, and returns the
42	* XML for the service check
43	*
44	* @param hostname the hostname to run the checks on
45	* @return the XML containing results from the check
46	*/
47	public String runServiceCheck(String hostname);
48
49
50	/**
51	* Return a String representation of what the plugin service
52	* check does (e.g. "Checks the xxx service is running on host")
53	*
54	* @return the description
55	*/
56	public String getDescription();
57
58	//---PRIVATE METHODS---
59
60	//---ACCESSOR/MUTATOR METHODS---
61
62	}