server/filter/PluginServiceCheckPipeline.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org
 * 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 java.io.*;
import java.util.*;

import uk.org.iscream.cms.util.*;
import uk.org.iscream.cms.server.componentmanager.*;
import uk.org.iscream.cms.server.core.*;

/**
 * This class setups up and manages Plugins for performing service
 * checks.  A list of plugins to use is specified in the configuration,
 * and these are all loaded for a specific host when asked.
 * It asks the configuration manager for references to ServiceChecks to
 * perform, thus ensuring only one instance of a service check is loaded
 * for all hosts.
 *
 * @author  $Author: tdb $
 * @version $Id: PluginServiceCheckPipeline.java,v 1.10 2003/02/05 16:43:47 tdb Exp $
 */
class PluginServiceCheckPipeline {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.10 $";
    
    /**
     * file name suffix for plugin classes:
     */
    private final String _suffix = "__ServiceCheck";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

    /**
     * Creates a new pipeline
     *
     * @param hostname the host this pipeline is for
     * @param manager the manager to obtain services checks from
     */
    public PluginServiceCheckPipeline(String hostname, PluginServiceCheckManager manager){
        _logger.write(toString(), Logger.SYSINIT, "Created.");
        _hostname = hostname;
        _manager = manager;
        _pipeline = buildPipeline();
        _created = System.currentTimeMillis();
    }

//---PUBLIC METHODS---

    /**
     * Instructs this pipeline to execute
     *
     * @return the XML generated by all the service checks
     */
    public String runPipeline(){
        // if our config has changed, rebuild the pipeline
        if (_refman.getCM().isModified(_fileList, _lastModified)) {
            _pipeline = buildPipeline();
        }
        // for each service check in the pipeline...
        String xml = "";
        Iterator i = _pipeline.iterator();
        while (i.hasNext()){
            PluginServiceCheck plugin = (PluginServiceCheck) i.next();
            xml += plugin.runServiceCheck(_hostname);
        }
        return xml;
    }

    /**
     * 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);
    }

//---PRIVATE METHODS---

    /**
     * Builds a pipeline of service checks to be run.
     * This method is called to read in the service checks
     * for a particular host from the configurations.  It then
     * builds a linked list of theses checks and then returns
     * them.
     *
     * @param hostname the hostname of the host to build the pipeline for
     * @return the pipeline
     */
    private LinkedList buildPipeline() {
        _logger.write(toString(), Logger.SYSMSG, "Creating plugin pipeline for service checks for - " + _hostname);
        
        String pluginsPackage, pluginsList;
        ConfigurationProxy cp = ConfigurationProxy.getInstance();
        String configName = "Host."+_hostname;
        
        _lastModified = cp.getLastModified(configName);
        _fileList = cp.getFileList(configName);
        
        try {
            pluginsPackage = cp.getProperty(configName, "Host.serviceChecksPackage");
            pluginsList = cp.getProperty(configName, "Host.serviceChecks");
        } catch(PropertyNotFoundException e) {
            pluginsPackage = "";
            pluginsList = "";
        }
        
        LinkedList pipeline = new LinkedList();
        _logger.write(toString(), Logger.DEBUG, "building pipeline of - " + pluginsList);        
        StringTokenizer st = new StringTokenizer(pluginsList, ";");
        while(st.hasMoreTokens()) {
            String className = pluginsPackage + "." + st.nextToken() + _suffix;
            pipeline.add(_manager.getServiceCheck(className));
        }
        return pipeline;
    }

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

    /**
     * Returns the system time that this
     * instance was created at.  Used for 
     * management of pipelines to determine
     * when its use is finished.
     *
     * @return the time of creation
     */
    public long getCreated() {
        return _created;
    }

//---ATTRIBUTES---
    
    /**
     * The name of the host this pipleline is for
     */
    private String _hostname;
    
    /**
     * Holds the current pipeline of plugins
     */
    private LinkedList _pipeline;
    
    /**
     * When this pipleine was created
     */
    private long _created;
    
    /**
     * When the current pipeline configuration was last modified
     */
    private long _lastModified;
    
    /**
     * The list of files used in the configuration
     */
    private String _fileList;
    
    /**
     * The plugin manager from which we can 
     * obtain references to service checks
     */
    private PluginServiceCheckManager _manager;
 
    /**
     * 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();
    
    /**
     * A reference to the reference manager in use
     */
    private ReferenceManager _refman = ReferenceManager.getInstance();

//---STATIC ATTRIBUTES---

}
Revision:	1.11
Committed:	Sun Aug 1 10:40:59 2004 UTC (19 years, 9 months ago) by tdb
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.10:	+3 -3 lines
Log Message:	Catch a lot of old URL's and update them. Also remove a couple of old files that aren't used.
#	User	Rev	Content
1	tdb	1.8	/*
2			* i-scream central monitoring system
3	tdb	1.11	* http://www.i-scream.org
4	tdb	1.8	* 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	ajm	1.1	//---PACKAGE DECLARATION---
22	tdb	1.7	package uk.org.iscream.cms.server.filter;
23	ajm	1.1
24			//---IMPORTS---
25			import java.io.*;
26			import java.util.*;
27
28	tdb	1.10	import uk.org.iscream.cms.util.*;
29	tdb	1.7	import uk.org.iscream.cms.server.componentmanager.*;
30			import uk.org.iscream.cms.server.core.*;
31	ajm	1.1
32			/**
33			* This class setups up and manages Plugins for performing service
34			* checks. A list of plugins to use is specified in the configuration,
35			* and these are all loaded for a specific host when asked.
36			* It asks the configuration manager for references to ServiceChecks to
37			* perform, thus ensuring only one instance of a service check is loaded
38			* for all hosts.
39			*
40	tdb	1.8	* @author $Author: tdb $
41	tdb	1.11	* @version $Id: PluginServiceCheckPipeline.java,v 1.10 2003/02/05 16:43:47 tdb Exp $
42	ajm	1.1	*/
43			class PluginServiceCheckPipeline {
44
45			//---FINAL ATTRIBUTES---
46
47			/**
48			* The current CVS revision of this class
49			*/
50	tdb	1.11	public final String REVISION = "$Revision: 1.10 $";
51	ajm	1.1
52			/**
53			* file name suffix for plugin classes:
54			*/
55			private final String _suffix = "__ServiceCheck";
56
57			//---STATIC METHODS---
58
59			//---CONSTRUCTORS---
60
61			/**
62			* Creates a new pipeline
63			*
64			* @param hostname the host this pipeline is for
65			* @param manager the manager to obtain services checks from
66			*/
67	ajm	1.3	public PluginServiceCheckPipeline(String hostname, PluginServiceCheckManager manager){
68	ajm	1.4	_logger.write(toString(), Logger.SYSINIT, "Created.");
69	ajm	1.1	_hostname = hostname;
70	ajm	1.4	_manager = manager;
71	ajm	1.1	_pipeline = buildPipeline();
72			_created = System.currentTimeMillis();
73			}
74
75			//---PUBLIC METHODS---
76
77			/**
78			* Instructs this pipeline to execute
79			*
80			* @return the XML generated by all the service checks
81			*/
82			public String runPipeline(){
83			// if our config has changed, rebuild the pipeline
84	ajm	1.2	if (_refman.getCM().isModified(_fileList, _lastModified)) {
85	ajm	1.1	_pipeline = buildPipeline();
86			}
87			// for each service check in the pipeline...
88			String xml = "";
89			Iterator i = _pipeline.iterator();
90			while (i.hasNext()){
91			PluginServiceCheck plugin = (PluginServiceCheck) i.next();
92	ajm	1.3	xml += plugin.runServiceCheck(_hostname);
93	ajm	1.1	}
94			return xml;
95			}
96
97			/**
98			* Overrides the {@link java.lang.Object#toString() Object.toString()}
99			* method to provide clean logging (every class should have this).
100			*
101	tdb	1.10	* This uses the uk.org.iscream.cms.util.NameFormat class
102	ajm	1.1	* to format the toString()
103			*
104			* @return the name of this class and its CVS revision
105			*/
106			public String toString() {
107			return FormatName.getName(
108			_name,
109			getClass().getName(),
110			REVISION);
111			}
112
113			//---PRIVATE METHODS---
114
115			/**
116			* Builds a pipeline of service checks to be run.
117			* This method is called to read in the service checks
118			* for a particular host from the configurations. It then
119			* builds a linked list of theses checks and then returns
120			* them.
121			*
122			* @param hostname the hostname of the host to build the pipeline for
123			* @return the pipeline
124			*/
125			private LinkedList buildPipeline() {
126	ajm	1.2	_logger.write(toString(), Logger.SYSMSG, "Creating plugin pipeline for service checks for - " + _hostname);
127	tdb	1.5
128			String pluginsPackage, pluginsList;
129			ConfigurationProxy cp = ConfigurationProxy.getInstance();
130			String configName = "Host."+_hostname;
131
132			_lastModified = cp.getLastModified(configName);
133			_fileList = cp.getFileList(configName);
134
135			try {
136			pluginsPackage = cp.getProperty(configName, "Host.serviceChecksPackage");
137			pluginsList = cp.getProperty(configName, "Host.serviceChecks");
138			} catch(PropertyNotFoundException e) {
139			pluginsPackage = "";
140			pluginsList = "";
141			}
142	ajm	1.1
143			LinkedList pipeline = new LinkedList();
144	ajm	1.4	_logger.write(toString(), Logger.DEBUG, "building pipeline of - " + pluginsList);
145	ajm	1.1	StringTokenizer st = new StringTokenizer(pluginsList, ";");
146			while(st.hasMoreTokens()) {
147			String className = pluginsPackage + "." + st.nextToken() + _suffix;
148			pipeline.add(_manager.getServiceCheck(className));
149			}
150			return pipeline;
151			}
152
153			//---ACCESSOR/MUTATOR METHODS---
154
155			/**
156			* Returns the system time that this
157			* instance was created at. Used for
158			* management of pipelines to determine
159			* when its use is finished.
160			*
161			* @return the time of creation
162			*/
163			public long getCreated() {
164			return _created;
165			}
166
167			//---ATTRIBUTES---
168
169			/**
170			* The name of the host this pipleline is for
171			*/
172			private String _hostname;
173
174			/**
175			* Holds the current pipeline of plugins
176			*/
177			private LinkedList _pipeline;
178
179			/**
180			* When this pipleine was created
181			*/
182			private long _created;
183
184			/**
185			* When the current pipeline configuration was last modified
186			*/
187			private long _lastModified;
188
189			/**
190			* The list of files used in the configuration
191			*/
192			private String _fileList;
193
194			/**
195			* The plugin manager from which we can
196			* obtain references to service checks
197			*/
198			private PluginServiceCheckManager _manager;
199
200			/**
201			* This is the friendly identifier of the
202			* component this class is running in.
203			* eg, a Filter may be called "filter1",
204			* If this class does not have an owning
205			* component, a name from the configuration
206			* can be placed here. This name could also
207			* be changed to null for utility classes.
208			*/
209			private String _name = FilterMain.NAME;
210
211			/**
212			* This holds a reference to the
213			* system logger that is being used.
214			*/
215			private Logger _logger = ReferenceManager.getInstance().getLogger();
216
217			/**
218			* A reference to the reference manager in use
219			*/
220			private ReferenceManager _refman = ReferenceManager.getInstance();
221
222			//---STATIC ATTRIBUTES---
223
224			}