OpenMRS

Timestamp:

12/31/07 16:21:18 (11 months ago)

Author:

bwolfe

Message:

Merging alpha to trunk [1776]:[2964] for OpenMRS 1.2 release

Files:

• openmrs/trunk/src/api/org/openmrs/api/context/ServiceContext.java (modified) (19 diffs)

openmrs/trunk/src/api/org/openmrs/api/context/ServiceContext.java

@@ +1 @@
+/**
+ * The contents of this file are subject to the OpenMRS Public License
+ * Version 1.0 (the "License"); you may not use this file except in
+ * compliance with the License. You may obtain a copy of the License at
+ * http://license.openmrs.org
+ *
+ * Software distributed under the License is distributed on an "AS IS"
+ * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
+ * License for the specific language governing rights and limitations
+ * under the License.
+ *
+ * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
+ */
-package org.openmrs.api.context;
-
@@ -33 +46 @@
-
-/**
-
-
-
+
+
- * 
-Only one <code>User</code> may be authenticated within a context at any
-given time
+This class should not be access directly, but rather used through the
+<code>Context</code> class
- * 
-
-
+
+
+
+
+
+
+
+
+
- */
-public class ServiceContext {
@@ -50 +69 @@
-        private Boolean refreshingContext = new Boolean(false);
-        
+        /**
+         * Static variable holding whether or not to use the system classloader.
+         * By default this is false so the openmrs classloader is used instead
+         */
+        private boolean useSystemClassLoader = false;
+        
-        // proxy factories used for programatically adding spring AOP  
-
-
-
-
+
+
+
+
+
+
+
+
-         */
-        private ServiceContext() { 
@@ -60 +89 @@
-        }
-        
+        /**
+         * There should only be one ServiceContext per openmrs (java virtual machine).
+         * 
+         * This method should be used when wanting to fetch the service context
+         * 
+         * Note: The ServiceContext shouldn't be used independently.  All calls
+         * should go through the Context
+         * 
+         * @return This VM's current ServiceContext.
+         * 
+         * @see org.openmrs.api.context.Context
+         */
-        public static ServiceContext getInstance() {
-                if (instance == null)
@@ -67 +108 @@
-        }
-        
-
-
-
+
+
+
+
+
+
+
+
-                                for (Map.Entry<Class, ProxyFactory> entry : instance.proxyFactories.entrySet()) {
-                                        log.debug("Class:ProxyFactory - " + entry.getKey().getName() + ":" + entry.getValue());
-                                }
-
-
-
-
+
-                        
+                        if (instance.proxyFactories != null)
+                                instance.proxyFactories.clear();
+                        
+                        instance.proxyFactories = null;
+                }
+                
+                if (log.isDebugEnabled())
-                        log.debug("Destroying ServiceContext instance: " + instance);
-}
+
-                instance = null;
-        }
@@ -104 +154 @@
-        }
-        
+        /**
+         * @return cohort related service
+         */
-        public CohortService getCohortService() {
-                return (CohortService) getService(CohortService.class);
-        }
-        
+        /**
+         * @param cohort related service
+         */
-        public void setCohortService(CohortService cs) {
-                setService(CohortService.class, cs);
@@ -215 +271 @@
-        
-        /**
-         * Get the message service.
-         * 
-         * There are several ways to deal with the service layer objects.
-         * 
-         * (1) Dependency injection (preferred) (2) Instantiate new instance within
-         * service (current implementation) (3) Use bean factory to get reference to
-         * bean (4) Use application context to get reference to bean
-         * 
-         * NOTE: I prefer method (1) but will not be able to get it to work
-         * correctly until I can refactor the Context class. The main issue is that
-         * the Context object is instantiated all over the place instead of being
-         * defined once in the bean definition file. Therefore, I cannot "inject"
-         * the message service (or any other service) because the client has control
-         * over instantiating the object. I don't like method (2) because I don't
-         * want the context to instantiate as there is a lot of work that goes into
-         * setting up the message service object. I couldn't figure out to get the
-         * "openmrs-servlet.xml" resource so I abandoned method (3). Therefore, I
-         * have decided to go with method (4) for now. It ties us (somewhat loosely)
-         * to the spring framework as we now have the Context object implement
-         * ApplicationContextAware. However, my plan is to make Context an interface
-         * and implements this interface as the SpringContext so that certain Spring
-         * services can be used (i.e. event publishing).
-         * 
-         * @return message service
-         */
@@ -378 +411 @@
-         * @return
-         */
-
+
+
-                ProxyFactory factory = proxyFactories.get(cls);
-                if (factory == null)
@@ -390 +424 @@
-         * @param advisor
-         */
-
+
+
-                ProxyFactory factory = getFactory(cls);
-                factory.addAdvisor(advisor);
@@ -400 +435 @@
-         * @param advice
-         */
-
+
+
-                ProxyFactory factory = getFactory(cls);
-                factory.addAdvice(advice);
@@ -410 +446 @@
-         * @param advisor
-         */
-
+
+
-                ProxyFactory factory = getFactory(cls);
-                factory.removeAdvisor(advisor);
@@ -420 +457 @@
-         * @param advice
-         */
-
+
+
-                ProxyFactory factory = getFactory(cls);
-                factory.removeAdvice(advice);
@@ -432 +470 @@
-         * @return Object that is a proxy for the <code>cls</code> class 
-         */
-
-
+
+
+
+
-                
-                // if the context is refreshing, wait until it is 
@@ -440 +480 @@
-                        if (refreshingContext.booleanValue())
-                                try {
+                                        log.warn("Waiting to get service: " + cls + " while the context is being refreshed");
-                                        refreshingContext.wait();
+                                        log.warn("Finished waiting to get service " + cls + " while the context was being refreshed");
-                                }
-                                catch (InterruptedException e) {
@@ -460 +502 @@
-         * @param classInstance the actual instance of the <code>cls</code> interface
-         */
-
+
+
-                
-                log.debug("Setting service: " + cls);
@@ -489 +532 @@
-         * @param list list of parameters
-         */
-
+
+
-                String classString = (String)params.get(0);
-                Object classInstance = params.get(1);
@@ -499 +543 @@
-                Class cls = null;
-                
+                // load the given 'classString' class from either the openmrs class
+                // loader or the system class loader depending on if we're in a testing
+                // environment or not (system == testing, openmrs == normal)
-                try {
-//ModuleClassLoader mcl = ModuleFactory.getModuleClassLoader(moduleId);
-
+if (useSystemClassLoader == false) {
+       
-                        
-
-
-
+
+
+
+
+
+
-                        }
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-                        }
-                        catch (Exception e) { /*pass*/ }
-                }
-                catch (ClassNotFoundException e) {
@@ -519 +572 @@
-                }
-                
+                // add this module service to the normal list of services
-                setService(cls, classInstance);
+        }
+        
+        /**
+         * Set this service context to use the system class loader if the 
+         * <code>useSystemClassLoader</code> is set to true.  If false, the openmrs 
+         * class loader is used to load module services
+         * 
+         * @param useSystemClassLoader true/false whether to use the system class loader
+         */
+        public void setUseSystemClassLoader(boolean useSystemClassLoader) {
+                this.useSystemClassLoader = useSystemClassLoader;
-        }
-        
@@ -547 +612 @@
-        }
-        
+        /**
+         * Returns true/false whether startRefreshingContext() has been called
+         * without a subsequent call to doneRefreshingContext() yet.  All methods
+         * involved in starting/stopping a module should call this if a service
+         * method is needed -- otherwise a deadlock will occur.
+         * 
+         * @return true/false whether the services are currently blocking waiting 
+         *                      for a call to doneRefreshingContext() 
+         */
+        public boolean isRefreshingContext() {
+                return refreshingContext.booleanValue();
+        }
+        
-}