View Javadoc

1   /*
2    * Copyright 2006-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.kuali.rice.ksb.messaging;
18  
19  import java.util.ArrayList;
20  import java.util.List;
21  
22  import org.kuali.rice.core.api.config.ConfigurationException;
23  import org.kuali.rice.core.api.config.module.RunMode;
24  import org.kuali.rice.core.api.config.property.ConfigContext;
25  import org.kuali.rice.ksb.api.bus.support.PropertyConditionalServiceBusExporter;
26  
27  /**
28   * A KSBExporter which will exports the service in the case where the specified
29   * run mode is set.  The run mode order proceeds as follows:
30   * 
31   * <p>remote -> embedded -> local
32   * 
33   * <p>If any of the earlier run modes in the list is set, then the ones after it
34   * will be applied.  So, if remote is set, then it will automatically be exported
35   * for embedded and local run modes.
36   * 
37   * @author Kuali Rice Team (kuali-rice@googlegroups.com)
38   */
39  public class RunModeServiceExporter extends PropertyConditionalServiceBusExporter {
40  	
41      private String runModePropertyName;
42      private RunMode validRunMode;
43      private static final List<RunMode> runModeHierarchy = new ArrayList<RunMode>();
44      static {
45      	runModeHierarchy.add(RunMode.THIN);
46      	runModeHierarchy.add(RunMode.REMOTE);
47      	runModeHierarchy.add(RunMode.EMBEDDED);
48      	runModeHierarchy.add(RunMode.LOCAL);
49      }
50  
51      @Override
52  	protected boolean shouldRemoteThisService() {
53      	if (validRunMode == null) {
54      		throw new ConfigurationException("The validRunMode property was not set.");
55      	}
56      	if (!runModeHierarchy.contains(getValidRunMode())) {
57      		throw new ConfigurationException("Given validRunMode is not a valid run mode.  Value was: " + getValidRunMode());
58      	}
59  		RunMode runModePropertyValue = RunMode.valueOf(ConfigContext.getCurrentContextConfig().getProperty(getRunModePropertyName()));
60  
61      	if (!runModeHierarchy.contains(runModePropertyValue)) {
62      		throw new ConfigurationException("Run mode value set on runModePropertyName of '" + getRunModePropertyName() + "' is not a valid run mode.  Value was: " + runModePropertyValue);
63      	}
64      	List<RunMode> validRunModeSubList = runModeHierarchy.subList(runModeHierarchy.indexOf(getValidRunMode()), runModeHierarchy.size());
65      	return validRunModeSubList.contains(runModePropertyValue) && super.shouldRemoteThisService();
66  	}
67  
68  	public String getRunModePropertyName() {
69          return this.runModePropertyName;
70      }
71  
72      public void setRunModePropertyName(String runModePropertyName) {
73          this.runModePropertyName = runModePropertyName;
74      }
75  
76      public RunMode getValidRunMode() {
77          return this.validRunMode;
78      }
79  
80      public void setValidRunMode(RunMode validRunMode) {
81          this.validRunMode = validRunMode;
82      }
83      
84  }