server/filtermanager/FilterManager.java

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.filtermanager;

//---IMPORTS---
import uk.org.iscream.cms.server.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: tdb1 $
 * @version $Id: FilterManager.java,v 1.22 2001/03/14 23:25:29 tdb1 Exp $
 */
public class FilterManager implements Component {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.22 $";
    
    /**
     * The friendly name for this component, used by
     * all related classes.
     */
    public static final String NAME = "FilterManager";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

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

//---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---

}            
Revision:	1.23
Committed:	Tue May 29 17:02:35 2001 UTC (22 years, 11 months ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.22:	+7 -7 lines
Log Message:	Major change in the java package naming. This has been held off for some time now, but it really needed doing. The future packaging of all i-scream products will be; uk.org.iscream.<product>.<subpart>.* In the case of the central monitoring system server this will be; uk.org.iscream.cms.server.* The whole server has been changed to follow this structure, and tested to a smallish extent. Further changes in other parts of the CMS will follow.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.org.iscream.cms.server.filtermanager;
3
4	//---IMPORTS---
5	import uk.org.iscream.cms.server.util.*;
6	import uk.org.iscream.cms.server.core.*;
7	import uk.org.iscream.cms.server.componentmanager.*;
8
9	/**
10	* The FilterManager handles initialisation
11	* of hosts with the system, allowing hosts to
12	* gain their configuration and a hook to a Filter
13	* to talk to.
14	*
15	* @author $Author: tdb1 $
16	* @version $Id: FilterManager.java,v 1.22 2001/03/14 23:25:29 tdb1 Exp $
17	*/
18	public class FilterManager implements Component {
19
20	//---FINAL ATTRIBUTES---
21
22	/**
23	* The current CVS revision of this class
24	*/
25	public static final String REVISION = "$Revision: 1.22 $";
26
27	/**
28	* The friendly name for this component, used by
29	* all related classes.
30	*/
31	public static final String NAME = "FilterManager";
32
33	//---STATIC METHODS---
34
35	//---CONSTRUCTORS---
36
37	//---PUBLIC METHODS---
38
39	/**
40	* This method starts the FilterManager
41	*/
42	public void start() throws ComponentStartException {
43	// get references to key objects
44	_logger = _refman.getLogger();
45
46	_logger.write(toString(), Logger.SYSINIT, "coming up");
47
48	// startup a thread to listen for hosts
49	HostListener hostListener = new HostListener();
50	hostListener.start();
51
52	_logger.write(toString(), Logger.SYSINIT, "started");
53	}
54
55	/**
56	* Does a dependency check. Used mainly at startup to
57	* see if the required dependencies (components) are up
58	* and running.
59	*
60	* @return a boolean value, true if the depdencies are satisfied
61	*/
62	public boolean depCheck() {
63	// This also depends on Filters.. but only when requested.
64	// I believe the code is in place to handle that elsewhere.
65	try {
66	org.omg.CORBA.Object obj;
67	obj = _refman.getCORBARef("iscream.Logger");
68	obj = _refman.getCORBARef("iscream.ConfigurationManager");
69	} catch(ComponentCORBAException e) {
70	System.err.println(toString() + ": Dependency Failure: "+e);
71	return false;
72	}
73	// dependency check suceeded
74	return true;
75	}
76
77	/**
78	* Overrides the {@link java.lang.Object#toString() Object.toString()}
79	* method to provide clean logging (every class should have this).
80	*
81	* This uses the uk.org.iscream.cms.server.util.NameFormat class
82	* to format the toString()
83	*
84	* @return the name of this class and its CVS revision
85	*/
86	public String toString() {
87	return FormatName.getName(
88	_name,
89	getClass().getName(),
90	REVISION);
91	}
92
93	//---PRIVATE METHODS---
94
95	//---ACCESSOR/MUTATOR METHODS---
96
97	//---ATTRIBUTES---
98
99	/**
100	* This is the friendly identifier of the
101	* component this class is running in.
102	* eg, a Filter may be called "filter1",
103	* If this class does not have an owning
104	* component, a name from the configuration
105	* can be placed here. This name could also
106	* be changed to null for utility classes.
107	*/
108	private String _name = FilterManager.NAME;
109
110	/**
111	* This holds a reference to the
112	* system logger that is being used.
113	*/
114	private Logger _logger;
115
116	/**
117	* A reference to the reference manager in use
118	*/
119	private ReferenceManager _refman = ReferenceManager.getInstance();
120
121	//---STATIC ATTRIBUTES---
122
123	}