server/filtermanager/FilterManager.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.filtermanager;

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

/**
 * The FilterManager handles initialisation
 * of hosts with the system, allowing hosts to
 * gain their configuration and a hook to a Filter 
 * to talk to.
 *
 * @author  $Author: tdb $
 * @version $Id: FilterManager.java,v 1.27 2003/02/05 16:43:47 tdb Exp $
 */
public class FilterManager implements Component {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.27 $";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

    /**
     * Constructs a FilterManager with the name given
     *
     * @param givenName the name
     */
    public FilterManager(String givenName) {
        NAME = givenName;
    }

//---PUBLIC METHODS---

    /**
     * This method starts the FilterManager
     */
     public void start() throws ComponentStartException {
        // get references to key objects
        _logger = _refman.getLogger();
        
        _logger.write(toString(), Logger.SYSINIT, "coming up");
        
        // startup a thread to listen for hosts
        HostListener hostListener = new HostListener();
        hostListener.start();
        
        _logger.write(toString(), Logger.SYSINIT, "started");
    }
    
    /**
     * Does a dependency check. Used mainly at startup to
     * see if the required dependencies (components) are up
     * and running.
     *
     * @return a boolean value, true if the depdencies are satisfied
     */
    public boolean depCheck() {
        // This also depends on Filters.. but only when requested.
        // I believe the code is in place to handle that elsewhere.
        try {
            org.omg.CORBA.Object obj;
            obj = _refman.getCORBARef("iscream.Logger");
            obj = _refman.getCORBARef("iscream.ConfigurationManager");
        } catch(ComponentCORBAException e) {
            System.err.println(toString() + ": Dependency Failure: "+e);
            return false;
        }
        // dependency check suceeded
        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);
    }

//---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 = FilterManager.NAME;

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

//---STATIC ATTRIBUTES---

    /**
     * The friendly name for this component, used by
     * all related classes.
     * This is set from the configuration.
     */
    public static String NAME;

}            
Revision:	1.28
Committed:	Sun Aug 1 10:41:05 2004 UTC (19 years, 9 months ago) by tdb
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.27:	+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.25	/*
2			* i-scream central monitoring system
3	tdb	1.28	* http://www.i-scream.org
4	tdb	1.25	* 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.23	package uk.org.iscream.cms.server.filtermanager;
23	tdb	1.1
24			//---IMPORTS---
25	tdb	1.27	import uk.org.iscream.cms.util.*;
26	tdb	1.23	import uk.org.iscream.cms.server.core.*;
27			import uk.org.iscream.cms.server.componentmanager.*;
28	tdb	1.1
29			/**
30	ajm	1.12	* The FilterManager handles initialisation
31			* of hosts with the system, allowing hosts to
32			* gain their configuration and a hook to a Filter
33			* to talk to.
34	tdb	1.1	*
35	tdb	1.24	* @author $Author: tdb $
36	tdb	1.28	* @version $Id: FilterManager.java,v 1.27 2003/02/05 16:43:47 tdb Exp $
37	tdb	1.1	*/
38	tdb	1.14	public class FilterManager implements Component {
39	tdb	1.1
40			//---FINAL ATTRIBUTES---
41
42			/**
43			* The current CVS revision of this class
44			*/
45	tdb	1.28	public static final String REVISION = "$Revision: 1.27 $";
46	tdb	1.1
47			//---STATIC METHODS---
48
49	ajm	1.12	//---CONSTRUCTORS---
50
51	tdb	1.24	/**
52			* Constructs a FilterManager with the name given
53			*
54			* @param givenName the name
55			*/
56			public FilterManager(String givenName) {
57			NAME = givenName;
58			}
59
60	ajm	1.12	//---PUBLIC METHODS---
61
62			/**
63			* This method starts the FilterManager
64			*/
65			public void start() throws ComponentStartException {
66	ajm	1.17	// get references to key objects
67	tdb	1.20	_logger = _refman.getLogger();
68	ajm	1.17
69	ajm	1.12	_logger.write(toString(), Logger.SYSINIT, "coming up");
70	tdb	1.10
71	tdb	1.15	// startup a thread to listen for hosts
72	tdb	1.18	HostListener hostListener = new HostListener();
73	tdb	1.10	hostListener.start();
74
75	ajm	1.12	_logger.write(toString(), Logger.SYSINIT, "started");
76	tdb	1.1	}
77	tdb	1.19
78			/**
79			* Does a dependency check. Used mainly at startup to
80			* see if the required dependencies (components) are up
81			* and running.
82			*
83			* @return a boolean value, true if the depdencies are satisfied
84			*/
85			public boolean depCheck() {
86	tdb	1.21	// This also depends on Filters.. but only when requested.
87			// I believe the code is in place to handle that elsewhere.
88			try {
89			org.omg.CORBA.Object obj;
90			obj = _refman.getCORBARef("iscream.Logger");
91			obj = _refman.getCORBARef("iscream.ConfigurationManager");
92			} catch(ComponentCORBAException e) {
93			System.err.println(toString() + ": Dependency Failure: "+e);
94			return false;
95			}
96			// dependency check suceeded
97	tdb	1.19	return true;
98			}
99
100	ajm	1.12	/**
101			* Overrides the {@link java.lang.Object#toString() Object.toString()}
102			* method to provide clean logging (every class should have this).
103			*
104	tdb	1.27	* This uses the uk.org.iscream.cms.util.NameFormat class
105	ajm	1.12	* to format the toString()
106			*
107			* @return the name of this class and its CVS revision
108			*/
109			public String toString() {
110			return FormatName.getName(
111	tdb	1.24	NAME,
112	ajm	1.13	getClass().getName(),
113	ajm	1.12	REVISION);
114			}
115	tdb	1.1
116			//---PRIVATE METHODS---
117
118			//---ACCESSOR/MUTATOR METHODS---
119
120			//---ATTRIBUTES---
121	ajm	1.12
122			/**
123			* This is the friendly identifier of the
124			* component this class is running in.
125			* eg, a Filter may be called "filter1",
126			* If this class does not have an owning
127			* component, a name from the configuration
128			* can be placed here. This name could also
129			* be changed to null for utility classes.
130			*/
131			private String _name = FilterManager.NAME;
132
133			/**
134			* This holds a reference to the
135			* system logger that is being used.
136			*/
137	ajm	1.17	private Logger _logger;
138	tdb	1.20
139			/**
140			* A reference to the reference manager in use
141			*/
142			private ReferenceManager _refman = ReferenceManager.getInstance();
143	tdb	1.1
144			//---STATIC ATTRIBUTES---
145	tdb	1.24
146			/**
147			* The friendly name for this component, used by
148			* all related classes.
149			* This is set from the configuration.
150			*/
151			public static String NAME;
152	tdb	1.1
153	tdb	1.27	}