server/filtermanager/FilterManager.java

//---PACKAGE DECLARATION---
package uk.ac.ukc.iscream.filtermanager;

//---IMPORTS---
import uk.ac.ukc.iscream.util.*;
import uk.ac.ukc.iscream.core.*;
import uk.ac.ukc.iscream.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.19 2001/03/14 01:34:33 tdb1 Exp $
 */
public class FilterManager implements Component {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.19 $";
    
    /**
     * 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() {
        // no real dependencies
        // although it will require Filter's, but these cannot
        // be predicted at this stage
        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.ac.ukc.iscream.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.20
Committed:	Wed Mar 14 01:43:53 2001 UTC (23 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.19:	+8 -3 lines
Log Message:	We weren't grabbing a ReferenceManager reference until startup, although there is no reason (unlike the Logger) why we can't grab it on construction.
#	User	Rev	Content
1	tdb	1.1	//---PACKAGE DECLARATION---
2	tdb	1.9	package uk.ac.ukc.iscream.filtermanager;
3	tdb	1.1
4			//---IMPORTS---
5	ajm	1.12	import uk.ac.ukc.iscream.util.*;
6	tdb	1.1	import uk.ac.ukc.iscream.core.*;
7	tdb	1.14	import uk.ac.ukc.iscream.componentmanager.*;
8	tdb	1.1
9			/**
10	ajm	1.12	* 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	tdb	1.1	*
15	tdb	1.19	* @author $Author: tdb1 $
16	tdb	1.20	* @version $Id: FilterManager.java,v 1.19 2001/03/14 01:34:33 tdb1 Exp $
17	tdb	1.1	*/
18	tdb	1.14	public class FilterManager implements Component {
19	tdb	1.1
20			//---FINAL ATTRIBUTES---
21
22			/**
23			* The current CVS revision of this class
24			*/
25	tdb	1.20	public static final String REVISION = "$Revision: 1.19 $";
26	ajm	1.12
27			/**
28	ajm	1.13	* The friendly name for this component, used by
29	ajm	1.12	* all related classes.
30			*/
31			public static final String NAME = "FilterManager";
32	tdb	1.1
33			//---STATIC METHODS---
34
35	ajm	1.12	//---CONSTRUCTORS---
36
37			//---PUBLIC METHODS---
38
39			/**
40			* This method starts the FilterManager
41			*/
42			public void start() throws ComponentStartException {
43	ajm	1.17	// get references to key objects
44	tdb	1.20	_logger = _refman.getLogger();
45	ajm	1.17
46	ajm	1.12	_logger.write(toString(), Logger.SYSINIT, "coming up");
47	tdb	1.10
48	tdb	1.15	// startup a thread to listen for hosts
49	tdb	1.18	HostListener hostListener = new HostListener();
50	tdb	1.10	hostListener.start();
51
52	ajm	1.12	_logger.write(toString(), Logger.SYSINIT, "started");
53	tdb	1.1	}
54	tdb	1.19
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			// no real dependencies
64			// although it will require Filter's, but these cannot
65			// be predicted at this stage
66			return true;
67			}
68
69	ajm	1.12	/**
70			* Overrides the {@link java.lang.Object#toString() Object.toString()}
71			* method to provide clean logging (every class should have this).
72			*
73			* This uses the uk.ac.ukc.iscream.util.NameFormat class
74			* to format the toString()
75			*
76			* @return the name of this class and its CVS revision
77			*/
78			public String toString() {
79			return FormatName.getName(
80			_name,
81	ajm	1.13	getClass().getName(),
82	ajm	1.12	REVISION);
83			}
84	tdb	1.1
85			//---PRIVATE METHODS---
86
87			//---ACCESSOR/MUTATOR METHODS---
88
89			//---ATTRIBUTES---
90	ajm	1.12
91			/**
92			* This is the friendly identifier of the
93			* component this class is running in.
94			* eg, a Filter may be called "filter1",
95			* If this class does not have an owning
96			* component, a name from the configuration
97			* can be placed here. This name could also
98			* be changed to null for utility classes.
99			*/
100			private String _name = FilterManager.NAME;
101
102			/**
103			* This holds a reference to the
104			* system logger that is being used.
105			*/
106	ajm	1.17	private Logger _logger;
107	tdb	1.20
108			/**
109			* A reference to the reference manager in use
110			*/
111			private ReferenceManager _refman = ReferenceManager.getInstance();
112	tdb	1.1
113			//---STATIC ATTRIBUTES---
114
115			}