server/client/WebFeeder.java

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

//---IMPORTS---
import uk.ac.ukc.iscream.componentmanager.*;
import uk.ac.ukc.iscream.core.*;
import uk.ac.ukc.iscream.util.*;

/**
 * Provides a feed to the webpage system.
 *
 * @author  $Author$
 * @version $Id$
 */
public class WebFeeder {

//---FINAL ATTRIBUTES---

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

    /**
     * Return a reference to the single class.
     * Construct it if it does not already exist, otherwise just return the reference.
     */
    public static WebFeeder getInstance() {
        if (_instance == null){
            _instance = new WebFeeder();
        }
        return _instance;
    }

//---CONSTRUCTORS---

    private WebFeeder() {
        // do something, or nothing.. but must be private
    }

//---PUBLIC METHODS---
    
    // TO BE COMPLETED
    // The following two methods should process and save
    // XMLPackets and Alerts, in a directory structure that
    // has been defined by the web page designer.
    
    // There may also be need to have a Thread to grab any
    // required config (groups, "nice names, etc) and dump
    // that to a file.
    
    public void receiveXMLPacket(XMLPacket packet) {
        // process and save
    }
    
    public void receiveAlert(Alert alert) {
        // process and save
    }
    
    /**
     * 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.FormatName 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 = ClientMain.NAME;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();
    
//---STATIC ATTRIBUTES---

    /**
     * A reference to the single instance of this class
     */
    private static WebFeeder _instance;

}
Revision:	1.1
Committed:	Wed Mar 7 01:55:51 2001 UTC (23 years, 2 months ago) by tdb
Branch:	MAIN
Log Message:	Added a new part of the local client called the WebFeeder. This class consists of three parts; WebFeeder__Monitor: provides a feed of XMLPackets to the WebFeeder WebFeeder__Alerter: provides a feed of Alerts to the WebFeeder WebFeeder: a singleton class that will manage dumping of XMLPackets and Alerts This data will be written out in a textual format, although this secion has not been completed. The WebFeeder may also provide configuration information, if required.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.ac.ukc.iscream.client;
3
4	//---IMPORTS---
5	import uk.ac.ukc.iscream.componentmanager.*;
6	import uk.ac.ukc.iscream.core.*;
7	import uk.ac.ukc.iscream.util.*;
8
9	/**
10	* Provides a feed to the webpage system.
11	*
12	* @author $Author$
13	* @version $Id$
14	*/
15	public class WebFeeder {
16
17	//---FINAL ATTRIBUTES---
18
19	/**
20	* The current CVS revision of this class
21	*/
22	public static final String REVISION = "$Revision: 1.1 $";
23
24	//---STATIC METHODS---
25
26	/**
27	* Return a reference to the single class.
28	* Construct it if it does not already exist, otherwise just return the reference.
29	*/
30	public static WebFeeder getInstance() {
31	if (_instance == null){
32	_instance = new WebFeeder();
33	}
34	return _instance;
35	}
36
37	//---CONSTRUCTORS---
38
39	private WebFeeder() {
40	// do something, or nothing.. but must be private
41	}
42
43	//---PUBLIC METHODS---
44
45	// TO BE COMPLETED
46	// The following two methods should process and save
47	// XMLPackets and Alerts, in a directory structure that
48	// has been defined by the web page designer.
49
50	// There may also be need to have a Thread to grab any
51	// required config (groups, "nice names, etc) and dump
52	// that to a file.
53
54	public void receiveXMLPacket(XMLPacket packet) {
55	// process and save
56	}
57
58	public void receiveAlert(Alert alert) {
59	// process and save
60	}
61
62	/**
63	* Overrides the {@link java.lang.Object#toString() Object.toString()}
64	* method to provide clean logging (every class should have this).
65	*
66	* This uses the uk.ac.ukc.iscream.util.FormatName class
67	* to format the toString()
68	*
69	* @return the name of this class and its CVS revision
70	*/
71	public String toString() {
72	return FormatName.getName(
73	_name,
74	getClass().getName(),
75	REVISION);
76	}
77
78	//---PRIVATE METHODS---
79
80	//---ACCESSOR/MUTATOR METHODS---
81
82	//---ATTRIBUTES---
83
84	/**
85	* This is the friendly identifier of the
86	* component this class is running in.
87	* eg, a Filter may be called "filter1",
88	* If this class does not have an owning
89	* component, a name from the configuration
90	* can be placed here. This name could also
91	* be changed to null for utility classes.
92	*/
93	private String _name = ClientMain.NAME;
94
95	/**
96	* This holds a reference to the
97	* system logger that is being used.
98	*/
99	private Logger _logger = ReferenceManager.getInstance().getLogger();
100
101	//---STATIC ATTRIBUTES---
102
103	/**
104	* A reference to the single instance of this class
105	*/
106	private static WebFeeder _instance;
107
108	}