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.server.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.12 2002/05/18 18:16:02 tdb Exp $
 */
public class EnforceEssentialData__Plugin implements PluginFilter {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.12 $";
    
    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 heartbeat packet seems ok
        if (packet.getParam("packet.attributes.type").equals("heartbeat")
                && packet.getParam("packet.attributes.date") != null
                && packet.getParam("packet.attributes.ip") != null
                && packet.getParam("packet.attributes.machine_name") != null){
            return true;
        }
        
        // 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.server.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.13
Committed:	Tue May 21 16:47:17 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.12:	+3 -2 lines
Log Message:	Added URL to GPL headers.
#	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.server.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.12 2002/05/18 18:16:02 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.12 $";
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 heartbeat packet seems ok
59	if (packet.getParam("packet.attributes.type").equals("heartbeat")
60	&& packet.getParam("packet.attributes.date") != null
61	&& packet.getParam("packet.attributes.ip") != null
62	&& packet.getParam("packet.attributes.machine_name") != null){
63	return true;
64	}
65
66	// return true if a queueStat packet seems ok
67	if (packet.getParam("packet.attributes.type").equals("queueStat")
68	&& packet.getParam("packet.attributes.date") != null
69	&& packet.getParam("packet.attributes.name") != null){
70	return true;
71	}
72
73	// return false if any of the essential data is not present
74	// in a "data" packet
75	if (packet.getParam("packet.attributes.machine_name") == null
76	\|\| packet.getParam("packet.attributes.ip") == null
77	\|\| packet.getParam("packet.attributes.seq_no") == null
78	\|\| packet.getParam("packet.attributes.date") == null
79	\|\| packet.getParam("packet.attributes.type") == null){
80	return false;
81	}
82
83	// otherwise return true!
84	return true;
85
86	}
87
88	/**
89	* Overrides the {@link java.lang.Object#toString() Object.toString()}
90	* method to provide clean logging (every class should have this).
91	*
92	* This uses the uk.org.iscream.cms.server.util.NameFormat class
93	* to format the toString()
94	*
95	* @return the name of this class and its CVS revision
96	*/
97	public String toString() {
98	return FormatName.getName(
99	_name,
100	getClass().getName(),
101	REVISION);
102	}
103
104	/**
105	* return the String representation of what the filter does
106	*/
107	public String getDescription(){
108	return DESC;
109	}
110
111	//---PRIVATE METHODS---
112
113	//---ACCESSOR/MUTATOR METHODS---
114
115	//---ATTRIBUTES---
116
117	/**
118	* This is the friendly identifier of the
119	* component this class is running in.
120	* eg, a Filter may be called "filter1",
121	* If this class does not have an owning
122	* component, a name from the configuration
123	* can be placed here. This name could also
124	* be changed to null for utility classes.
125	*/
126	private String _name = FilterMain.NAME;
127
128	/**
129	* This holds a reference to the
130	* system logger that is being used.
131	*/
132	private Logger _logger = ReferenceManager.getInstance().getLogger();
133
134	//---STATIC ATTRIBUTES---
135
136	}