server/rootfilter/CIWrapper.java

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

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

/**
 * A ClientInterface wrapper - the CI objects are pushed data,
 * yet data is pulled from the queue. This will sit inbetween
 * for now, until the CI design is changed.
 *
 * @author  $Author: tdb1 $
 * @version $Id $
 */
public class CIWrapper extends Thread {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Sets up the wrapper, with a single destination and a queue.
     *
     * @param destination the client interface to send the xml to
     * @param queue a reference to a queue to use
     */
    public CIWrapper(ClientInterface destination, Queue queue){
        // set the Thread name
        setName("rootfilter.CIWrapper");
        
        _destination = destination;
        _queue = queue;
        _queueID = queue.getQueue();
    }

//---PUBLIC METHODS---

    /**
     * start the thread and thus gets and sends data
     */
    public void run() {
        String xml = null;
        boolean run = true;
        while(run) {
            // get a line of XML from the queue
            try {
                xml = (String) _queue.get(_queueID);
            }
            catch (InvalidQueueException e) {
                _logger.write(toString(), Logger.ERROR, "Queue error: "+e);
            }
            // pass it on to the destination
            try {
                _destination.receiveXML(xml);
            }
            catch (org.omg.CORBA.COMM_FAILURE e) {
                run = false;
                _logger.write(toString(), Logger.ERROR, "Connection failure (COMM_FAILURE), client interface shutdown? : "+e);
            }
            catch (org.omg.CORBA.TRANSIENT e) {
                run = false;
                _logger.write(toString(), Logger.ERROR, "Connection failure (TRANSIENT), client interface shutdown? : "+e);
            }
        }
        // looks like something when wrong in communication
        // rather than fall over in a heap, lets just stop
        // cleanly and shutdown our queue...
        _logger.write(toString(), Logger.SYSMSG, "Shutting Down...");
        _queue.removeQueue(_queueID);
    }

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

    /**
     * A reference to a Queue object.
     */
    private Queue _queue;
    
    /**
     * Our Queue id.
     */
    private int _queueID;
    
    /**
     * the interface this thread is sending data to
     */
    private ClientInterface _destination;
    
    /**
     * 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 = RootFilter.NAME;

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

//---STATIC ATTRIBUTES---

}
Revision:	1.11
Committed:	Mon Nov 26 19:21:40 2001 UTC (22 years, 5 months ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.10:	+21 -3 lines
Log Message:	Some error checking to handle client interfaces disconnecting without any warning. In fact, this shouldn't happen, but it'd be nice if it was cleanly dealt with :)
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.org.iscream.cms.server.rootfilter;
3
4	//---IMPORTS---
5	import uk.org.iscream.cms.server.core.*;
6	import uk.org.iscream.cms.server.componentmanager.*;
7	import uk.org.iscream.cms.server.clientinterface.*;
8	import uk.org.iscream.cms.server.util.*;
9
10	/**
11	* A ClientInterface wrapper - the CI objects are pushed data,
12	* yet data is pulled from the queue. This will sit inbetween
13	* for now, until the CI design is changed.
14	*
15	* @author $Author: tdb1 $
16	* @version $Id $
17	*/
18	public class CIWrapper extends Thread {
19
20	//---FINAL ATTRIBUTES---
21
22	/**
23	* The current CVS revision of this class
24	*/
25	public final String REVISION = "$Revision: 1.10 $";
26
27	//---STATIC METHODS---
28
29	//---CONSTRUCTORS---
30
31	/**
32	* Sets up the wrapper, with a single destination and a queue.
33	*
34	* @param destination the client interface to send the xml to
35	* @param queue a reference to a queue to use
36	*/
37	public CIWrapper(ClientInterface destination, Queue queue){
38	// set the Thread name
39	setName("rootfilter.CIWrapper");
40
41	_destination = destination;
42	_queue = queue;
43	_queueID = queue.getQueue();
44	}
45
46	//---PUBLIC METHODS---
47
48	/**
49	* start the thread and thus gets and sends data
50	*/
51	public void run() {
52	String xml = null;
53	boolean run = true;
54	while(run) {
55	// get a line of XML from the queue
56	try {
57	xml = (String) _queue.get(_queueID);
58	}
59	catch (InvalidQueueException e) {
60	_logger.write(toString(), Logger.ERROR, "Queue error: "+e);
61	}
62	// pass it on to the destination
63	try {
64	_destination.receiveXML(xml);
65	}
66	catch (org.omg.CORBA.COMM_FAILURE e) {
67	run = false;
68	_logger.write(toString(), Logger.ERROR, "Connection failure (COMM_FAILURE), client interface shutdown? : "+e);
69	}
70	catch (org.omg.CORBA.TRANSIENT e) {
71	run = false;
72	_logger.write(toString(), Logger.ERROR, "Connection failure (TRANSIENT), client interface shutdown? : "+e);
73	}
74	}
75	// looks like something when wrong in communication
76	// rather than fall over in a heap, lets just stop
77	// cleanly and shutdown our queue...
78	_logger.write(toString(), Logger.SYSMSG, "Shutting Down...");
79	_queue.removeQueue(_queueID);
80	}
81
82	/**
83	* Overrides the {@link java.lang.Object#toString() Object.toString()}
84	* method to provide clean logging (every class should have this).
85	*
86	* This uses the uk.org.iscream.cms.server.util.NameFormat class
87	* to format the toString()
88	*
89	* @return the name of this class and its CVS revision
90	*/
91	public String toString() {
92	return FormatName.getName(
93	_name,
94	getClass().getName(),
95	REVISION);
96	}
97
98	//---PRIVATE METHODS---
99
100	//---ACCESSOR/MUTATOR METHODS---
101
102	//---ATTRIBUTES---
103
104	/**
105	* A reference to a Queue object.
106	*/
107	private Queue _queue;
108
109	/**
110	* Our Queue id.
111	*/
112	private int _queueID;
113
114	/**
115	* the interface this thread is sending data to
116	*/
117	private ClientInterface _destination;
118
119	/**
120	* This is the friendly identifier of the
121	* component this class is running in.
122	* eg, a Filter may be called "filter1",
123	* If this class does not have an owning
124	* component, a name from the configuration
125	* can be placed here. This name could also
126	* be changed to null for utility classes.
127	*/
128	private String _name = RootFilter.NAME;
129
130	/**
131	* This holds a reference to the
132	* system logger that is being used.
133	*/
134	private Logger _logger = ReferenceManager.getInstance().getLogger();
135
136	//---STATIC ATTRIBUTES---
137
138	}