EIP-50 - Make the list of watched table names configurable

commons/src/main/java/org/openmrs/eip/Constants.java

@@ -13,5 +13,7 @@ public class Constants {
 	public static final String MGT_DATASOURCE_NAME = "mngtDataSource";
 
 	public static final String HTTP_HEADER_AUTH = "Authorization";
+
+    public static final String PROP_WATCHED_TABLES = "eip.watchedTables";
 
 }

commons/src/main/java/org/openmrs/eip/Utils.java

@@ -5,20 +5,18 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+import org.springframework.core.env.Environment;
+
 public class Utils {
 
-	private static final String[] WATCHED_TABLES = new String[] { "PERSON", "PATIENT", "VISIT", "ENCOUNTER", "OBS",
-	        "PERSON_ATTRIBUTE", "PATIENT_PROGRAM", "PATIENT_STATE", "VISIT_ATTRIBUTE", "ENCOUNTER_DIAGNOSIS", "CONDITION",
-	        "PERSON_NAME", "ALLERGY", "PERSON_ADDRESS", "PATIENT_IDENTIFIER", "ORDERS", "DRUG_ORDER", "TEST_ORDER",
-	        "RELATIONSHIP", "ENCOUNTER_PROVIDER", "ORDER_GROUP", "PATIENT_PROGRAM_ATTRIBUTE" };
-
 	/**
 	 * Gets a list of all watched table names
 	 * 
 	 * @return
 	 */
 	public static List<String> getWatchedTables() {
-		return Arrays.asList(WATCHED_TABLES);
+		String watchedTables = WatcherContext.getBean(Environment.class).getProperty(Constants.PROP_WATCHED_TABLES);
+		return Arrays.asList(watchedTables.split(","));
 	}
 
 	/**

commons/src/main/java/org/openmrs/eip/WatcherContext.java

@@ -0,0 +1,27 @@
+package org.openmrs.eip;
+
+import org.springframework.beans.BeansException;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.stereotype.Component;
+
+@Component
+public class WatcherContext implements ApplicationContextAware {
+
+	private static ApplicationContext appContext;
+
+	@Override
+	public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
+		appContext = applicationContext;
+	}
+
+	/**
+	 * Gets the bean matching the specified type from the application context
+	 *
+	 * @return an instance of the bean matching the specified type
+	 */
+	public static <T> T getBean(Class<T> clazz) {
+		return appContext.getBean(clazz);
+	}
+
+}

commons/src/test/java/org/openmrs/eip/UtilsTest.java

@@ -8,7 +8,15 @@
 import java.util.stream.Collectors;
 
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mockito;
+import org.powermock.api.mockito.PowerMockito;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
+import org.springframework.core.env.Environment;
 
+@RunWith(PowerMockRunner.class)
+@PrepareForTest(WatcherContext.class)
 public class UtilsTest {
 
 	@Test
@@ -89,4 +97,17 @@ public void getTablesInHierarchy_shouldReturnCommaSeparatedListOfSubclassAndSupe
 		assertTrue(tables.contains("'orders'"));
 	}
 
+	@Test
+	public void getWatchedTables_shouldReturnTheWatchedTableNames() {
+		PowerMockito.mockStatic(WatcherContext.class);
+		Environment mockEnv = Mockito.mock(Environment.class);
+		Mockito.when(WatcherContext.getBean(Environment.class)).thenReturn(mockEnv);
+		Mockito.when(mockEnv.getProperty(Constants.PROP_WATCHED_TABLES)).thenReturn("person,patient,visit");
+		List<String> watchedTables = Utils.getWatchedTables();
+		assertEquals(3, watchedTables.size());
+		assertTrue(watchedTables.contains("person"));
+		assertTrue(watchedTables.contains("patient"));
+		assertTrue(watchedTables.contains("visit"));
+	}
+
 }

docs/custom/application.properties

@@ -15,6 +15,9 @@
 #
 eip.home=${user.home}${file.separator}.openmrs-eip
 
+# A comma separated list of database tables names to watch for changes
+eip.watchedTables=
+
 # Camel endpoints that need to be notified of DB events
 db-event.destinations=