filter/plugins/EnforceEssentialData__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 rejects packets that do not
 * contain all of the 'essential' data.
 *
 * @author  $Author: tdb $
 * @version $Id: EnforceEssentialData__Plugin.java,v 1.14 2003/02/05 16:43:47 tdb Exp $
 */
public class EnforceEssentialData__Plugin implements PluginFilter {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.14 $";
    
    public final String DESC = "Rejects packets that do not have an ip, machine_name, seq_no, date and type specified as attributes of the root packet tag.";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    // apply the filter and return true if successful.
    public boolean runFilter(XMLPacket packet){
        
        // return true if a queueStat packet seems ok
        if (packet.getParam("packet.attributes.type").equals("queueStat")
                && packet.getParam("packet.attributes.date") != null
                && packet.getParam("packet.attributes.name") != null){
            return true;
        }
        
        // return false if any of the essential data is not present
        // in a "data" packet
        if (packet.getParam("packet.attributes.machine_name") == null
                || packet.getParam("packet.attributes.ip") == null
                || packet.getParam("packet.attributes.seq_no") == null
                || packet.getParam("packet.attributes.date") == null
                || packet.getParam("packet.attributes.type") == null){
            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.15
Committed:	Mon Feb 24 20:18:49 2003 UTC (21 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.14:	+2 -10 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.
#	Content
1	/*
2	* i-scream central monitoring system
3	* http://www.i-scream.org.uk
4	* 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	//---PACKAGE DECLARATION---
22	package uk.org.iscream.cms.server.filter.plugins;
23
24	//---IMPORTS---
25	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	import uk.org.iscream.cms.util.*;
29	import uk.org.iscream.cms.server.componentmanager.*;
30
31	/**
32	* This plugin rejects packets that do not
33	* contain all of the 'essential' data.
34	*
35	* @author $Author: tdb $
36	* @version $Id: EnforceEssentialData__Plugin.java,v 1.14 2003/02/05 16:43:47 tdb Exp $
37	*/
38	public class EnforceEssentialData__Plugin implements PluginFilter {
39
40	//---FINAL ATTRIBUTES---
41
42	/**
43	* The current CVS revision of this class
44	*/
45	public final String REVISION = "$Revision: 1.14 $";
46
47	public final String DESC = "Rejects packets that do not have an ip, machine_name, seq_no, date and type specified as attributes of the root packet tag.";
48
49	//---STATIC METHODS---
50
51	//---CONSTRUCTORS---
52
53	//---PUBLIC METHODS---
54
55	// apply the filter and return true if successful.
56	public boolean runFilter(XMLPacket packet){
57
58	// return true if a queueStat packet seems ok
59	if (packet.getParam("packet.attributes.type").equals("queueStat")
60	&& packet.getParam("packet.attributes.date") != null
61	&& packet.getParam("packet.attributes.name") != null){
62	return true;
63	}
64
65	// return false if any of the essential data is not present
66	// in a "data" packet
67	if (packet.getParam("packet.attributes.machine_name") == null
68	\|\| packet.getParam("packet.attributes.ip") == null
69	\|\| packet.getParam("packet.attributes.seq_no") == null
70	\|\| packet.getParam("packet.attributes.date") == null
71	\|\| packet.getParam("packet.attributes.type") == null){
72	return false;
73	}
74
75	// otherwise return true!
76	return true;
77
78	}
79
80	/**
81	* Overrides the {@link java.lang.Object#toString() Object.toString()}
82	* method to provide clean logging (every class should have this).
83	*
84	* This uses the uk.org.iscream.cms.util.NameFormat class
85	* to format the toString()
86	*
87	* @return the name of this class and its CVS revision
88	*/
89	public String toString() {
90	return FormatName.getName(
91	_name,
92	getClass().getName(),
93	REVISION);
94	}
95
96	/**
97	* return the String representation of what the filter does
98	*/
99	public String getDescription(){
100	return DESC;
101	}
102
103	//---PRIVATE METHODS---
104
105	//---ACCESSOR/MUTATOR METHODS---
106
107	//---ATTRIBUTES---
108
109	/**
110	* This is the friendly identifier of the
111	* component this class is running in.
112	* eg, a Filter may be called "filter1",
113	* If this class does not have an owning
114	* component, a name from the configuration
115	* can be placed here. This name could also
116	* be changed to null for utility classes.
117	*/
118	private String _name = FilterMain.NAME;
119
120	/**
121	* This holds a reference to the
122	* system logger that is being used.
123	*/
124	private Logger _logger = ReferenceManager.getInstance().getLogger();
125
126	//---STATIC ATTRIBUTES---
127
128	}