filter/plugins/TypeChecker__Plugin.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org.uk
 * 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.plugins;

//---IMPORTS---
import uk.org.iscream.cms.server.filter.PluginFilter;
import uk.org.iscream.cms.server.filter.*;
import uk.org.iscream.cms.server.core.*;
import uk.org.iscream.cms.util.*;
import uk.org.iscream.cms.server.componentmanager.*;

/**
 * This plugin is designed to check the type of incoming packets.
 *
 * @author  $Author: tdb $
 * @version $Id: TypeChecker__Plugin.java,v 1.8 2003/02/05 16:43:47 tdb Exp $
 */
public class TypeChecker__Plugin implements PluginFilter {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.8 $";
    
    public final String DESC = "Checks the type attribute in the packet attributes. This must be correctly specified to allow the packet through.";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    // apply the filter and return true if successful.
    public boolean runFilter(XMLPacket packet){
        
        // return false if one of the predetermined types is not set.
        if(packet.getParam("packet.attributes.type") == null
                || (!packet.getParam("packet.attributes.type").equals("queueStat")
                && !packet.getParam("packet.attributes.type").equals("data"))){
            return false;
        }
                
        // otherwise return true!
        return true;
        
    }

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.org.iscream.cms.util.NameFormat class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

    /**
     * return the String representation of what the filter does
     */
    public String getDescription(){
        return DESC;
    }

//---PRIVATE METHODS---

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

//---ATTRIBUTES---

    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = FilterMain.NAME;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();

//---STATIC ATTRIBUTES---

}
Revision:	1.9
Committed:	Mon Feb 24 20:18:49 2003 UTC (21 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.8:	+3 -4 lines
Log Message:	Fairly major commit. This will break the current version of ihost, but this had to be done really to give Pete something to test the new ihost against. The main change here is removal of the TCP Heartbeat functionality from the filter. This meant the following features stopped working :- - Heartbeat testing - Configuration checking - Service checks The heartbeat testing, specifically the monitor, now looks at the presence of UDP packets instead. Before it just looked for the presence of a TCP heartbeat packet, so the change their is fairly negligible. Of course this means heartbeat testing now relies on the UDP working... but I don't see this as a problem. Configuration checking has been repositioned in to the filtermanager. This is a backwards compatible change - the filtermanager should still perform as it should for older hosts. But now there's an extra command to check the configuration is up-to-date, with a similar format to the old TCP protocol in the filter. (although we may optimise this soon) The service checks are broken. This isn't a major issue for us as they were pretty useless in the first place. The concept is good, but the checks are just far too primitive. I expect at some point I'll work on a seperate component that just monitors services, which will replace this function. Further changes in the server include removal of the key checking code, as this relied on a bolt on to the TCP heartbeat protocol to ship the key. This got more akward than originally planned, so I'm happy to drop the idea. In the long term we hope to replace this with a public key systems for signing and even encryption. Finally, general tidy up to remove other bits of code that check for TCP heartbeat packets when they don't need to any more.
#	User	Rev	Content
1	tdb	1.6	/*
2			* i-scream central monitoring system
3	tdb	1.7	* http://www.i-scream.org.uk
4	tdb	1.6	* Copyright (C) 2000-2002 i-scream
5			*
6			* This program is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU General Public License
8			* as published by the Free Software Foundation; either version 2
9			* of the License, or (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19			*/
20
21	tdb	1.1	//---PACKAGE DECLARATION---
22	tdb	1.5	package uk.org.iscream.cms.server.filter.plugins;
23	tdb	1.1
24			//---IMPORTS---
25	tdb	1.5	import uk.org.iscream.cms.server.filter.PluginFilter;
26			import uk.org.iscream.cms.server.filter.*;
27			import uk.org.iscream.cms.server.core.*;
28	tdb	1.8	import uk.org.iscream.cms.util.*;
29	tdb	1.5	import uk.org.iscream.cms.server.componentmanager.*;
30	tdb	1.1
31			/**
32			* This plugin is designed to check the type of incoming packets.
33			*
34	tdb	1.6	* @author $Author: tdb $
35	tdb	1.9	* @version $Id: TypeChecker__Plugin.java,v 1.8 2003/02/05 16:43:47 tdb Exp $
36	tdb	1.1	*/
37			public class TypeChecker__Plugin implements PluginFilter {
38
39			//---FINAL ATTRIBUTES---
40
41			/**
42			* The current CVS revision of this class
43			*/
44	tdb	1.9	public final String REVISION = "$Revision: 1.8 $";
45	tdb	1.1
46			public final String DESC = "Checks the type attribute in the packet attributes. This must be correctly specified to allow the packet through.";
47
48			//---STATIC METHODS---
49
50			//---CONSTRUCTORS---
51
52			//---PUBLIC METHODS---
53
54			// apply the filter and return true if successful.
55			public boolean runFilter(XMLPacket packet){
56
57			// return false if one of the predetermined types is not set.
58			if(packet.getParam("packet.attributes.type") == null
59	tdb	1.9	\|\| (!packet.getParam("packet.attributes.type").equals("queueStat")
60	tdb	1.2	&& !packet.getParam("packet.attributes.type").equals("data"))){
61	tdb	1.1	return false;
62			}
63
64			// otherwise return true!
65			return true;
66
67			}
68
69			/**
70			* Overrides the {@link java.lang.Object#toString() Object.toString()}
71			* method to provide clean logging (every class should have this).
72			*
73	tdb	1.8	* This uses the uk.org.iscream.cms.util.NameFormat class
74	tdb	1.1	* to format the toString()
75			*
76			* @return the name of this class and its CVS revision
77			*/
78			public String toString() {
79			return FormatName.getName(
80			_name,
81			getClass().getName(),
82			REVISION);
83			}
84
85			/**
86			* return the String representation of what the filter does
87			*/
88			public String getDescription(){
89			return DESC;
90			}
91
92			//---PRIVATE METHODS---
93
94			//---ACCESSOR/MUTATOR METHODS---
95
96			//---ATTRIBUTES---
97
98			/**
99			* This is the friendly identifier of the
100			* component this class is running in.
101			* eg, a Filter may be called "filter1",
102			* If this class does not have an owning
103			* component, a name from the configuration
104			* can be placed here. This name could also
105			* be changed to null for utility classes.
106			*/
107			private String _name = FilterMain.NAME;
108
109			/**
110			* This holds a reference to the
111			* system logger that is being used.
112			*/
113			private Logger _logger = ReferenceManager.getInstance().getLogger();
114
115			//---STATIC ATTRIBUTES---
116
117			}