cms/util/ReferenceManager.java

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

//---IMPORTS---
import org.omg.CORBA.ORB;
import org.omg.CosNaming.*;
import org.omg.PortableServer.*;
import uk.ac.ukc.iscream.core.*;

/**
 * This class returns references for global system objects.
 * This class is used to create and return references to objects
 * that are required throughout the system.  Most of which
 * are CORBA based.  It also manages the ORB for the component.
 *
 * It is a singleton object with a static method to obtain a
 * reference to it.  This removes the need for passing
 * references to all the objects it contains throughout 
 * a component.
 *
 * @author  $Author: ajm4 $
 * @version $Id: ReferenceManager.java,v 1.5 2000/12/11 16:38:09 ajm4 Exp $
 */
public class ReferenceManager {

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

    /**
     * TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
     * @deprecated should know longer use this method to construct a refman
     */
    public static ReferenceManager init(String[] args, String name) throws AlreadyInitialisedException {
        System.out.println("LEGACY CALL - SORT THIS OUT! name=" + name);
        if (_instance != null) {
            throw new AlreadyInitialisedException("init has already been called");
        }
        _instance = new ReferenceManager(args, name);
        return _instance;
    }
    
    /**
     * This returns a reference to the single instance of the
     * ReferenceManager.
     *
     * This creates the single instance of the ReferenceManager
     * if it does not exist by calling the private constructor.
     *
     * @return a reference to the ReferenceManager
     */
    public static ReferenceManager getInstance() {
        if (_instance == null) {
            _instance = new ReferenceManager();
        }
        return _instance;
    }

//---CONSTRUCTORS---

    /**
     * This is a private constructor
     * This ensures that the system performs according to a Singleton design pattern
     */
    private ReferenceManager() {
        _orb = ORB.init(new String[] {}, null);
    }
    
    /**
     * TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
     * @deprecated should know longer use this method to construct a refman
     */
    private ReferenceManager(String[] args, String name) {
        System.out.println("LEGACY CALL - SORT THIS OUT! name=" + name);
        _orb = ORB.init(args, null);
        _name = name;
    }

//---PUBLIC METHODS---

    /**
     * Obtains a CORBA reference through the naming service
     * for the named object.
     * This will throw a Error if there is an error
     *
     * @param name the name of the CORBA object to resolve
     *
     * @return a reference to the object
     */
    public org.omg.CORBA.Object getCORBARef(String name) {
        org.omg.CORBA.Object objRef = null;
        try {
            objRef = getNS().resolve(getNS().to_name(name));
        } catch (org.omg.CosNaming.NamingContextPackage.CannotProceed e) {
            dieWithError("\nCRITICAL:Naming Service Cannot Proceed - when resolving reference to " + name + "!\n" + 
                              "         Please check with your CORBA naming service provider.");
        } catch (org.omg.CosNaming.NamingContextPackage.InvalidName e) {
            dieWithError("\nCRITICAL:Invalid Name - when resolving reference to " + name + "!\n" + 
                              "         Please check with your CORBA naming service provider.");
        } catch (org.omg.CosNaming.NamingContextPackage.NotFound e) {
            dieWithError("\nCRITICAL:Not Found - when resolving reference to " + name + "!\n" + 
                              "         Please check that this component is running.");
        }
        return objRef;
    }

    /** 
     * Binds a given servant with the given name
     * to the naming service.
     * Calls the dieWithError()!
     *
     * @param objRef a reverence to the servant object
     * @param name the name to bind to the naming service with
     */
    public void bindToOrb(org.omg.PortableServer.Servant objRef, String name) {
        try {
            getNS().bind(getNS().to_name(name), getRootPOA().servant_to_reference(objRef));
        } catch (org.omg.PortableServer.POAPackage.WrongPolicy e) {
            dieWithError("\nCRITICAL:Wrong POA Policy - when binding " + name + "!\n" + 
                              "         This indicates an error with your ORB.");
        } catch (org.omg.PortableServer.POAPackage.ServantNotActive e) {
            dieWithError("\nCRITICAL:ServantNotActive - when binding " + name + "!\n" + 
                              "         This indicates an error with your ORB.");
        } catch (org.omg.CosNaming.NamingContextPackage.InvalidName e) {
            dieWithError("\nCRITICAL:Invalid Name - when binding " + name + "!\n" + 
                              "         Please check with your CORBA naming service provider.");
        } catch (org.omg.CosNaming.NamingContextPackage.CannotProceed e) {
            dieWithError("\nCRITICAL:Naming Service Cannot Proceed - when binding " + name + "!\n" + 
                              "         Please check with your CORBA naming service provider.");
        } catch (org.omg.CosNaming.NamingContextPackage.NotFound e) {
            dieWithError("\nCRITICAL:Naming Service Not Found - when binding " + name + "!\n" + 
                              "         Please check with your CORBA naming service provider.");
        } catch (org.omg.CosNaming.NamingContextPackage.AlreadyBound e) {
            dieWithError("\nCRITICAL:Already Bound - when binding " + name + "!\n" + 
                              "         Another component with this name is already running.");
        }
    }
    
    /**
     * Activates the POA
     * This will throw a Error if there is an error
     */
    public void activatePOA() {
        try {
            getRootPOA().the_POAManager().activate();
        } catch (org.omg.PortableServer.POAManagerPackage.AdapterInactive e) {
            dieWithError("\nCRITICAL:POA Set Inactive - when trying to activate POA!\n" + 
                              "         This indicates an error with your ORB.");
        }
    }
    
    /**
     * 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(
            null,
            this.getClass().getName(),
            REVISION);
    }

//---PRIVATE METHODS---

    /**
     * If there are any CORBA errors this method is called with the 
     * error message.
     *
     * Currently this prints the error, on the local err stream.  Will
     * print to the logger if one is available.
     *
     * ANY CALLS TO THIS METHOD CAUSE
     * THE SYSTEM TO EXIT WITH A NON
     * ZERO CODE!
     *
     * @param message the error message to die with
     */
    private void dieWithError(String message) {
        System.err.println(message);
        if (_logger != null) {
            _logger.write(toString(), Logger.FATAL, message);
        }
        System.exit(1);
    }

//---ACCESSOR/MUTATOR METHODS---

    /**
     * Returns a reference to the ORB
     *
     * @return the reference this class holds
     */
    public ORB getORB() {
        return _orb;
    }

    /**
     * Returns a reference to the Root POA
     * This will throw a Error if there is an error
     *
     * @return the reference this class holds
     */
    public POA getRootPOA() {
        if (_rootPOA == null) {
            org.omg.CORBA.Object objRef = null;
            try {
                objRef = getORB().resolve_initial_references("RootPOA");
            } catch (org.omg.CORBA.ORBPackage.InvalidName e) {
                dieWithError("\nCRITICAL:Unable to resolve reference to the RootPOA!\n" + 
                                  "         This indicates an error with your ORB.");
            }
            _rootPOA = POAHelper.narrow(objRef);
        }
        return _rootPOA;
    }
    
    /**
     * Returns a reference to the Naming Service
     * This will throw a Error if there is an error
     *
     * @return the reference this class holds
     */
    public NamingContextExt getNS() {
        if (_ns == null) {
            org.omg.CORBA.Object objRef = null;
            try {
                objRef = getORB().resolve_initial_references("NameService");
            } catch (org.omg.CORBA.ORBPackage.InvalidName e) {
                dieWithError("\nCRITICAL:Unable to resolve reference to the Naming Service!\n" +
                                  "         Please check with your CORBA naming service provider.");
            }
            _ns = NamingContextExtHelper.narrow(objRef);
        }
        // check we managed to talk to the naming service
        if (_ns == null) {
            dieWithError("\nCRITICAL:Unable to resolve reference to the Naming Service!\n" +
                              "         Please check with your CORBA naming service provider.");
        }
        return _ns;
    }
    
    /**
     * Returns a reference to the configuration manager
     * This will throw a Error if there is an error
     *
     * @return the reference this class holds
     */
    public ConfigurationManager getCM() {
        if (_cm == null) {
            _cm = ConfigurationManagerHelper.narrow(getCORBARef("iscream.ConfigurationManager"));
        }
        // check we managed to talk to the configuration manager
        if (_cm == null) {
            dieWithError("\nCRITICAL:Unable to resolve reference to the Configuration Manager!\n" +
                              "         Please check with your CORBA naming service provider.");
        }
        return _cm;
    }

    /**
     * Returns a reference to the logger
     * This will throw a Error if there is an error
     *
     * @return the reference this class holds
     */
    public Logger getLogger() {
        if (_logger == null) {
            _logger = LoggerHelper.narrow(getCORBARef("iscream.Logger"));
        }
        return _logger;
    }

    /**
     * Sets the reference to the name
     * TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
     * @deprecated not stored in the refman any more - see Template.class
     * @param the new name
     */
    public void setName(String name) {
        System.out.println("LEGACY CALL - SORT THIS OUT! name=" + name);
        _name = name;
    }
    
    /**
     * Returns a reference to the name
     * TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
     * @deprecated not stored in the refman any more - see Template.class
     * @return the reference this class holds
     */
    public String getName() {
        System.out.println("LEGACY CALL - SORT THIS OUT! name=" + _name);
        return _name;
    }

//---ATTRIBUTES---
    
    /**
     * The ORB
     */
    private ORB _orb;
    
    /**
     * The Naming Service
     */
    private NamingContextExt _ns;
    
    /**
     * The Root POA
     */
    private POA _rootPOA;

    /**
     * The configuration manager
     */
    private ConfigurationManager _cm;

    /**
     * The logger
     */
    private Logger _logger;
    
    /**
     * The name
     * TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
     * @deprecated not stored in the refman any more - see Template.class
     */
    private String _name;

//---STATIC ATTRIBUTES---
    
    /**
     * A reference to the single instance of this class
     */
    private static ReferenceManager _instance; 
}
Revision:	1.6
Committed:	Tue Dec 12 17:13:22 2000 UTC (23 years, 4 months ago) by ajm
Branch:	MAIN
Changes since 1.5:	+70 -37 lines
Log Message:	Modified Has deprecated methods for legacy code Conforms to new standards Has nicer error handling...
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.ac.ukc.iscream.util;
3
4	//---IMPORTS---
5	import org.omg.CORBA.ORB;
6	import org.omg.CosNaming.*;
7	import org.omg.PortableServer.*;
8	import uk.ac.ukc.iscream.core.*;
9
10	/**
11	* This class returns references for global system objects.
12	* This class is used to create and return references to objects
13	* that are required throughout the system. Most of which
14	* are CORBA based. It also manages the ORB for the component.
15	*
16	* It is a singleton object with a static method to obtain a
17	* reference to it. This removes the need for passing
18	* references to all the objects it contains throughout
19	* a component.
20	*
21	* @author $Author: ajm4 $
22	* @version $Id: ReferenceManager.java,v 1.5 2000/12/11 16:38:09 ajm4 Exp $
23	*/
24	public class ReferenceManager {
25
26	//---FINAL ATTRIBUTES---
27
28	/**
29	* The current CVS revision of this class
30	*/
31	public final String REVISION = "$Revision: 1.5 $";
32
33	//---STATIC METHODS---
34
35	/**
36	* TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
37	* @deprecated should know longer use this method to construct a refman
38	*/
39	public static ReferenceManager init(String[] args, String name) throws AlreadyInitialisedException {
40	System.out.println("LEGACY CALL - SORT THIS OUT! name=" + name);
41	if (_instance != null) {
42	throw new AlreadyInitialisedException("init has already been called");
43	}
44	_instance = new ReferenceManager(args, name);
45	return _instance;
46	}
47
48	/**
49	* This returns a reference to the single instance of the
50	* ReferenceManager.
51	*
52	* This creates the single instance of the ReferenceManager
53	* if it does not exist by calling the private constructor.
54	*
55	* @return a reference to the ReferenceManager
56	*/
57	public static ReferenceManager getInstance() {
58	if (_instance == null) {
59	_instance = new ReferenceManager();
60	}
61	return _instance;
62	}
63
64	//---CONSTRUCTORS---
65
66	/**
67	* This is a private constructor
68	* This ensures that the system performs according to a Singleton design pattern
69	*/
70	private ReferenceManager() {
71	_orb = ORB.init(new String[] {}, null);
72	}
73
74	/**
75	* TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
76	* @deprecated should know longer use this method to construct a refman
77	*/
78	private ReferenceManager(String[] args, String name) {
79	System.out.println("LEGACY CALL - SORT THIS OUT! name=" + name);
80	_orb = ORB.init(args, null);
81	_name = name;
82	}
83
84	//---PUBLIC METHODS---
85
86	/**
87	* Obtains a CORBA reference through the naming service
88	* for the named object.
89	* This will throw a Error if there is an error
90	*
91	* @param name the name of the CORBA object to resolve
92	*
93	* @return a reference to the object
94	*/
95	public org.omg.CORBA.Object getCORBARef(String name) {
96	org.omg.CORBA.Object objRef = null;
97	try {
98	objRef = getNS().resolve(getNS().to_name(name));
99	} catch (org.omg.CosNaming.NamingContextPackage.CannotProceed e) {
100	dieWithError("\nCRITICAL:Naming Service Cannot Proceed - when resolving reference to " + name + "!\n" +
101	" Please check with your CORBA naming service provider.");
102	} catch (org.omg.CosNaming.NamingContextPackage.InvalidName e) {
103	dieWithError("\nCRITICAL:Invalid Name - when resolving reference to " + name + "!\n" +
104	" Please check with your CORBA naming service provider.");
105	} catch (org.omg.CosNaming.NamingContextPackage.NotFound e) {
106	dieWithError("\nCRITICAL:Not Found - when resolving reference to " + name + "!\n" +
107	" Please check that this component is running.");
108	}
109	return objRef;
110	}
111
112	/**
113	* Binds a given servant with the given name
114	* to the naming service.
115	* Calls the dieWithError()!
116	*
117	* @param objRef a reverence to the servant object
118	* @param name the name to bind to the naming service with
119	*/
120	public void bindToOrb(org.omg.PortableServer.Servant objRef, String name) {
121	try {
122	getNS().bind(getNS().to_name(name), getRootPOA().servant_to_reference(objRef));
123	} catch (org.omg.PortableServer.POAPackage.WrongPolicy e) {
124	dieWithError("\nCRITICAL:Wrong POA Policy - when binding " + name + "!\n" +
125	" This indicates an error with your ORB.");
126	} catch (org.omg.PortableServer.POAPackage.ServantNotActive e) {
127	dieWithError("\nCRITICAL:ServantNotActive - when binding " + name + "!\n" +
128	" This indicates an error with your ORB.");
129	} catch (org.omg.CosNaming.NamingContextPackage.InvalidName e) {
130	dieWithError("\nCRITICAL:Invalid Name - when binding " + name + "!\n" +
131	" Please check with your CORBA naming service provider.");
132	} catch (org.omg.CosNaming.NamingContextPackage.CannotProceed e) {
133	dieWithError("\nCRITICAL:Naming Service Cannot Proceed - when binding " + name + "!\n" +
134	" Please check with your CORBA naming service provider.");
135	} catch (org.omg.CosNaming.NamingContextPackage.NotFound e) {
136	dieWithError("\nCRITICAL:Naming Service Not Found - when binding " + name + "!\n" +
137	" Please check with your CORBA naming service provider.");
138	} catch (org.omg.CosNaming.NamingContextPackage.AlreadyBound e) {
139	dieWithError("\nCRITICAL:Already Bound - when binding " + name + "!\n" +
140	" Another component with this name is already running.");
141	}
142	}
143
144	/**
145	* Activates the POA
146	* This will throw a Error if there is an error
147	*/
148	public void activatePOA() {
149	try {
150	getRootPOA().the_POAManager().activate();
151	} catch (org.omg.PortableServer.POAManagerPackage.AdapterInactive e) {
152	dieWithError("\nCRITICAL:POA Set Inactive - when trying to activate POA!\n" +
153	" This indicates an error with your ORB.");
154	}
155	}
156
157	/**
158	* Overrides the {@link java.lang.Object#toString() Object.toString()}
159	* method to provide clean logging (every class should have this).
160	*
161	* This uses the uk.ac.ukc.iscream.util.NameFormat class
162	* to format the toString()
163	*
164	* @return the name of this class and its CVS revision
165	*/
166	public String toString() {
167	return FormatName.getName(
168	null,
169	this.getClass().getName(),
170	REVISION);
171	}
172
173	//---PRIVATE METHODS---
174
175	/**
176	* If there are any CORBA errors this method is called with the
177	* error message.
178	*
179	* Currently this prints the error, on the local err stream. Will
180	* print to the logger if one is available.
181	*
182	* ANY CALLS TO THIS METHOD CAUSE
183	* THE SYSTEM TO EXIT WITH A NON
184	* ZERO CODE!
185	*
186	* @param message the error message to die with
187	*/
188	private void dieWithError(String message) {
189	System.err.println(message);
190	if (_logger != null) {
191	_logger.write(toString(), Logger.FATAL, message);
192	}
193	System.exit(1);
194	}
195
196	//---ACCESSOR/MUTATOR METHODS---
197
198	/**
199	* Returns a reference to the ORB
200	*
201	* @return the reference this class holds
202	*/
203	public ORB getORB() {
204	return _orb;
205	}
206
207	/**
208	* Returns a reference to the Root POA
209	* This will throw a Error if there is an error
210	*
211	* @return the reference this class holds
212	*/
213	public POA getRootPOA() {
214	if (_rootPOA == null) {
215	org.omg.CORBA.Object objRef = null;
216	try {
217	objRef = getORB().resolve_initial_references("RootPOA");
218	} catch (org.omg.CORBA.ORBPackage.InvalidName e) {
219	dieWithError("\nCRITICAL:Unable to resolve reference to the RootPOA!\n" +
220	" This indicates an error with your ORB.");
221	}
222	_rootPOA = POAHelper.narrow(objRef);
223	}
224	return _rootPOA;
225	}
226
227	/**
228	* Returns a reference to the Naming Service
229	* This will throw a Error if there is an error
230	*
231	* @return the reference this class holds
232	*/
233	public NamingContextExt getNS() {
234	if (_ns == null) {
235	org.omg.CORBA.Object objRef = null;
236	try {
237	objRef = getORB().resolve_initial_references("NameService");
238	} catch (org.omg.CORBA.ORBPackage.InvalidName e) {
239	dieWithError("\nCRITICAL:Unable to resolve reference to the Naming Service!\n" +
240	" Please check with your CORBA naming service provider.");
241	}
242	_ns = NamingContextExtHelper.narrow(objRef);
243	}
244	// check we managed to talk to the naming service
245	if (_ns == null) {
246	dieWithError("\nCRITICAL:Unable to resolve reference to the Naming Service!\n" +
247	" Please check with your CORBA naming service provider.");
248	}
249	return _ns;
250	}
251
252	/**
253	* Returns a reference to the configuration manager
254	* This will throw a Error if there is an error
255	*
256	* @return the reference this class holds
257	*/
258	public ConfigurationManager getCM() {
259	if (_cm == null) {
260	_cm = ConfigurationManagerHelper.narrow(getCORBARef("iscream.ConfigurationManager"));
261	}
262	// check we managed to talk to the configuration manager
263	if (_cm == null) {
264	dieWithError("\nCRITICAL:Unable to resolve reference to the Configuration Manager!\n" +
265	" Please check with your CORBA naming service provider.");
266	}
267	return _cm;
268	}
269
270	/**
271	* Returns a reference to the logger
272	* This will throw a Error if there is an error
273	*
274	* @return the reference this class holds
275	*/
276	public Logger getLogger() {
277	if (_logger == null) {
278	_logger = LoggerHelper.narrow(getCORBARef("iscream.Logger"));
279	}
280	return _logger;
281	}
282
283	/**
284	* Sets the reference to the name
285	* TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
286	* @deprecated not stored in the refman any more - see Template.class
287	* @param the new name
288	*/
289	public void setName(String name) {
290	System.out.println("LEGACY CALL - SORT THIS OUT! name=" + name);
291	_name = name;
292	}
293
294	/**
295	* Returns a reference to the name
296	* TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
297	* @deprecated not stored in the refman any more - see Template.class
298	* @return the reference this class holds
299	*/
300	public String getName() {
301	System.out.println("LEGACY CALL - SORT THIS OUT! name=" + _name);
302	return _name;
303	}
304
305	//---ATTRIBUTES---
306
307	/**
308	* The ORB
309	*/
310	private ORB _orb;
311
312	/**
313	* The Naming Service
314	*/
315	private NamingContextExt _ns;
316
317	/**
318	* The Root POA
319	*/
320	private POA _rootPOA;
321
322	/**
323	* The configuration manager
324	*/
325	private ConfigurationManager _cm;
326
327	/**
328	* The logger
329	*/
330	private Logger _logger;
331
332	/**
333	* The name
334	* TO BE REMOVED ONCE CODE TIDY HAS COMPLETED!
335	* @deprecated not stored in the refman any more - see Template.class
336	*/
337	private String _name;
338
339	//---STATIC ATTRIBUTES---
340
341	/**
342	* A reference to the single instance of this class
343	*/
344	private static ReferenceManager _instance;
345	}