VIVO-1246 Improve the ConfigurationBeanLoader (#52)

* VIVO-1246 improve the ConfigurationBeanLoader: Add cardinality parameters minOccurs and maxOccurs Create README.md document in the edu.cornell.mannlib.vitro.webapp.utils.configuration package Split large class of unit tests into separate classes by functionality * VIVO-1247, remove duplicate code used with ConfigurationBeanLoader. Now that the @Property annotation includes cardinality parameters, we can remove a lot of duplicate code. * VIVO-1246 Move unit tests to the new location. * VIVO-1246 The documentation was in the wrong place.
vivo-project · Jan 3, 2017 · a8ec633 · a8ec633
1 parent fc83c9f
commit a8ec633
Show file tree

Hide file tree

Showing 22 changed files with 1,413 additions and 702 deletions.
diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/application/ApplicationImpl.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/application/ApplicationImpl.java
@@ -25,7 +25,6 @@
 import edu.cornell.mannlib.vitro.webapp.startup.StartupStatus;
 import edu.cornell.mannlib.vitro.webapp.triplesource.impl.BasicCombinedTripleSource;
 import edu.cornell.mannlib.vitro.webapp.utils.configuration.Property;
-import edu.cornell.mannlib.vitro.webapp.utils.configuration.Validation;
 
 /**
  * The basic implementation of the Application interface.
@@ -69,143 +68,69 @@ public SearchEngine getSearchEngine() {
 		return searchEngine;
 	}
 
-	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasSearchEngine")
+	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasSearchEngine", minOccurs = 1, maxOccurs = 1)
 	public void setSearchEngine(SearchEngine se) {
-		if (searchEngine == null) {
-			searchEngine = se;
-		} else {
-			throw new IllegalStateException(
-					"Configuration includes multiple SearchEngine instances: "
-							+ searchEngine + ", and " + se);
-		}
+		searchEngine = se;
 	}
 
 	@Override
 	public SearchIndexer getSearchIndexer() {
 		return searchIndexer;
 	}
 
-	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasSearchIndexer")
+	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasSearchIndexer", minOccurs = 1, maxOccurs = 1)
 	public void setSearchIndexer(SearchIndexer si) {
-		if (searchIndexer == null) {
-			searchIndexer = si;
-		} else {
-			throw new IllegalStateException(
-					"Configuration includes multiple SearchIndexer instances: "
-							+ searchIndexer + ", and " + si);
-		}
+		searchIndexer = si;
 	}
 
 	@Override
 	public ImageProcessor getImageProcessor() {
 		return imageProcessor;
 	}
 
-	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasImageProcessor")
+	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasImageProcessor", minOccurs = 1, maxOccurs = 1)
 	public void setImageProcessor(ImageProcessor ip) {
-		if (imageProcessor == null) {
-			imageProcessor = ip;
-		} else {
-			throw new IllegalStateException(
-					"Configuration includes multiple ImageProcessor instances: "
-							+ imageProcessor + ", and " + ip);
-		}
+		imageProcessor = ip;
 	}
 
 	@Override
 	public FileStorage getFileStorage() {
 		return fileStorage;
 	}
 
-	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasFileStorage")
+	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasFileStorage", minOccurs = 1, maxOccurs = 1)
 	public void setFileStorage(FileStorage fs) {
-		if (fileStorage == null) {
-			fileStorage = fs;
-		} else {
-			throw new IllegalStateException(
-					"Configuration includes multiple FileStorage instances: "
-							+ fileStorage + ", and " + fs);
-		}
+		fileStorage = fs;
 	}
 
 	@Override
 	public ContentTripleSource getContentTripleSource() {
 		return contentTripleSource;
 	}
 
-	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasContentTripleSource")
+	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasContentTripleSource", minOccurs = 1, maxOccurs = 1)
 	public void setContentTripleSource(ContentTripleSource source) {
-		if (contentTripleSource == null) {
-			contentTripleSource = source;
-		} else {
-			throw new IllegalStateException(
-					"Configuration includes multiple instances of ContentTripleSource: "
-							+ contentTripleSource + ", and " + source);
-		}
+		contentTripleSource = source;
 	}
 
 	@Override
 	public ConfigurationTripleSource getConfigurationTripleSource() {
 		return configurationTripleSource;
 	}
 
-	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasConfigurationTripleSource")
+	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasConfigurationTripleSource", minOccurs = 1, maxOccurs = 1)
 	public void setConfigurationTripleSource(ConfigurationTripleSource source) {
-		if (configurationTripleSource == null) {
-			configurationTripleSource = source;
-		} else {
-			throw new IllegalStateException(
-					"Configuration includes multiple instances of ConfigurationTripleSource: "
-							+ configurationTripleSource + ", and " + source);
-		}
+		configurationTripleSource = source;
 	}
 
 	@Override
 	public TBoxReasonerModule getTBoxReasonerModule() {
 		return tboxReasonerModule;
 	}
 
-	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasTBoxReasonerModule")
+	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#hasTBoxReasonerModule", minOccurs = 1, maxOccurs = 1)
 	public void setTBoxReasonerModule(TBoxReasonerModule module) {
-		if (tboxReasonerModule == null) {
-			tboxReasonerModule = module;
-		} else {
-			throw new IllegalStateException(
-					"Configuration includes multiple instances of TBoxReasonerModule: "
-							+ tboxReasonerModule + ", and " + module);
-		}
-	}
-
-	@Validation
-	public void validate() throws Exception {
-		if (searchEngine == null) {
-			throw new IllegalStateException(
-					"Configuration did not include a SearchEngine.");
-		}
-		if (searchIndexer == null) {
-			throw new IllegalStateException(
-					"Configuration did not include a SearchIndexer.");
-		}
-		if (imageProcessor == null) {
-			throw new IllegalStateException(
-					"Configuration did not include an ImageProcessor.");
-		}
-		if (fileStorage == null) {
-			throw new IllegalStateException(
-					"Configuration did not include a FileStorage.");
-		}
-		if (contentTripleSource == null) {
-			throw new IllegalStateException(
-					"Configuration did not include a ContentTripleSource.");
-		}
-		if (configurationTripleSource == null) {
-			throw new IllegalStateException(
-					"Configuration did not include a ConfigurationTripleSource.");
-		}
-		if (tboxReasonerModule == null) {
-			throw new IllegalStateException(
-					"Configuration did not include a TBoxReasonerModule.");
-		}
+		tboxReasonerModule = module;
 	}
 
 	@Override

diff --git a/...n/java/edu/cornell/mannlib/vitro/webapp/searchengine/InstrumentedSearchEngineWrapper.java b/...n/java/edu/cornell/mannlib/vitro/webapp/searchengine/InstrumentedSearchEngineWrapper.java
@@ -26,7 +26,6 @@
 import edu.cornell.mannlib.vitro.webapp.modules.searchEngine.SearchResultDocument;
 import edu.cornell.mannlib.vitro.webapp.modules.searchEngine.SearchResultDocumentList;
 import edu.cornell.mannlib.vitro.webapp.utils.configuration.Property;
-import edu.cornell.mannlib.vitro.webapp.utils.configuration.Validation;
 
 /**
  * Manages the life-cycle of the SearchEngine. Adds logging, controlled by
@@ -40,26 +39,11 @@ public class InstrumentedSearchEngineWrapper implements SearchEngine {
 
 	private volatile LifecycleState lifecycleState = NEW;
 
-	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#wraps")
+	@Property(uri = "http://vitro.mannlib.cornell.edu/ns/vitro/ApplicationSetup#wraps", minOccurs = 1, maxOccurs = 1)
 	public void setInnerEngine(SearchEngine inner) {
-		if (innerEngine == null) {
-			innerEngine = inner;
-		} else {
-			throw new IllegalStateException(
-					"Configuration includes multiple SearchEngine instancess: "
-							+ innerEngine + ", and " + inner);
-		}
+		innerEngine = inner;
 	}
 
-	@Validation
-	public void validate() throws Exception {
-		if (innerEngine == null) {
-			throw new IllegalStateException(
-					"Configuration did not include a wrapped SearchEngine.");
-		}
-	}
-
-
 	/**
 	 * Complain unless ACTIVE.
 	 */
@@ -222,13 +206,13 @@ public int documentCount() throws SearchEngineException {
 			return count;
 		}
 	}
-	
+
 	// ----------------------------------------------------------------------
 	// Helper classes
 	// ----------------------------------------------------------------------
 
-
-	private static class SearchResponseForDocumentCount implements SearchResponse {
+	private static class SearchResponseForDocumentCount implements
+			SearchResponse {
 		private final int count;
 
 		public SearchResponseForDocumentCount(int count) {
@@ -254,28 +238,29 @@ public SearchFacetField getFacetField(String name) {
 		public List<SearchFacetField> getFacetFields() {
 			return Collections.emptyList();
 		}
-
-		private class EmptyDocumentListWithCount implements SearchResultDocumentList {
-				@Override
-				public Iterator<SearchResultDocument> iterator() {
-					return Collections.emptyIterator();
-				}
-
-				@Override
-				public int size() {
-					return 0;
-				}
-
-				@Override
-				public long getNumFound() {
-					return count;
-				}
-
-				@Override
-				public SearchResultDocument get(int i) {
-					throw new ArrayIndexOutOfBoundsException(i);
-				}
+
+		private class EmptyDocumentListWithCount implements
+				SearchResultDocumentList {
+			@Override
+			public Iterator<SearchResultDocument> iterator() {
+				return Collections.emptyIterator();
+			}
+
+			@Override
+			public int size() {
+				return 0;
+			}
+
+			@Override
+			public long getNumFound() {
+				return count;
+			}
+
+			@Override
+			public SearchResultDocument get(int i) {
+				throw new ArrayIndexOutOfBoundsException(i);
+			}
 		}
 	}
-	
+
 }