From efcc677d96910ccf092591e0e7618249ed1b223f Mon Sep 17 00:00:00 2001
From: Jim Blake <jeb228@cornell.edu>
Date: Wed, 11 Jun 2014 17:50:47 -0400
Subject: [PATCH] Document the improvements to the developer panel

---
 webapp/config/example.developer.properties    | 56 +++++++++++++++----
 .../vitro/webapp/utils/developer/Key.java     | 10 ++--
 2 files changed, 51 insertions(+), 15 deletions(-)

diff --git a/webapp/config/example.developer.properties b/webapp/config/example.developer.properties
index ae395081c..f90be6be8 100644
--- a/webapp/config/example.developer.properties
+++ b/webapp/config/example.developer.properties
@@ -1,5 +1,6 @@
 #
 # -----------------------------------------------------------------------------
+#
 # Runtime properties for developer mode.
 #
 # If the developer.properties file is present in your VIVO home directory, it
@@ -21,39 +22,74 @@
 # General options
 #------------------------------------------------------------------------------
 
-# developer.enabled = true
-# developer.permitAnonymousControl
+# developer.enabled = false
+# developer.permitAnonymousControl = false
 
 
 #------------------------------------------------------------------------------
 # Freemarker 
 #------------------------------------------------------------------------------
 
-# developer.insertFreemarkerDelimiters = true
-# developer.defeatFreemarkerCache = true
+# developer.defeatFreemarkerCache = false
+# developer.insertFreemarkerDelimiters = false
 
 
 #------------------------------------------------------------------------------
 # Page configuration 
 #------------------------------------------------------------------------------
 
-# developer.pageContents.logCustomListView = true
-# developer.pageContents.logCustomShortView = true
+# developer.pageContents.logCustomListView = false
+# developer.pageContents.logCustomShortView = false
 
 
 #------------------------------------------------------------------------------
 # Internationalization 
 #------------------------------------------------------------------------------
 
-# developer.i18n.defeatCache = true
-# developer.i18n.logStringRequests
+# developer.i18n.defeatCache = false
+# developer.i18n.logStringRequests = false
 
 
 #------------------------------------------------------------------------------
 # Logging SPARQL queries
 #------------------------------------------------------------------------------
 
-# developer.loggingRDFService.enable = true
-# developer.loggingRDFService.stackTrace = true
+# developer.loggingRDFService.enable = false
+# developer.loggingRDFService.stackTrace = false
 # developer.loggingRDFService.queryRestriction = .*
 # developer.loggingRDFService.stackRestriction = .*
+
+
+#------------------------------------------------------------------------------
+# Logging Search indexing
+#------------------------------------------------------------------------------
+
+# developer.searchIndex.enable = false
+# developer.searchIndex.showDocuments = false
+# developer.searchIndex.uriOrNameRestriction = .*
+# developer.searchIndex.documentRestriction = .*
+# developer.searchDeletions.enable = false
+
+
+#------------------------------------------------------------------------------
+# Logging Search queries
+#------------------------------------------------------------------------------
+
+# developer.searchEngine.enable = false
+# developer.searchEngine.addStackTrace = false
+# developer.searchEngine.addResults = false
+# developer.searchEngine.queryRestriction =	.*
+# developer.searchEngine.stackRestriction =	.*
+
+
+#------------------------------------------------------------------------------
+# Logging policy decisions (authorization)
+#------------------------------------------------------------------------------
+
+# developer.authorization.logDecisions.enable = false
+# developer.authorization.logDecisions.addIdentifiers = false
+# developer.authorization.logDecisions.skipInconclusive = false
+# developer.authorization.logDecisions.actionRestriction = false
+# developer.authorization.logDecisions.userRestriction = false
+# developer.authorization.logDecisions.policyRestriction = false
+
diff --git a/webapp/src/edu/cornell/mannlib/vitro/webapp/utils/developer/Key.java b/webapp/src/edu/cornell/mannlib/vitro/webapp/utils/developer/Key.java
index 9c19c51ad..529ac07c1 100644
--- a/webapp/src/edu/cornell/mannlib/vitro/webapp/utils/developer/Key.java
+++ b/webapp/src/edu/cornell/mannlib/vitro/webapp/utils/developer/Key.java
@@ -97,12 +97,12 @@ public enum Key {
 	SEARCH_INDEX_SHOW_DOCUMENTS("developer.searchIndex.showDocuments", true),
 
 	/**
-	 * Log indexing operations only if the document contents match this regular
-	 * expression.
+	 * Log indexing operations only if one of the document identifiers match
+	 * this regular expression.
 	 */
 	SEARCH_INDEX_URI_OR_NAME_RESTRICTION(
 			"developer.searchIndex.uriOrNameRestriction", false),
-			
+
 	/**
 	 * Log indexing operations only if the document contents match this regular
 	 * expression.
@@ -150,13 +150,13 @@ public enum Key {
 			"developer.authorization.logDecisions.enable", true),
 
 	/**
-	 * Enable the PolicyDecisionLogger.
+	 * When logging policy decisions, add the identifier bundle.
 	 */
 	AUTHORIZATION_LOG_DECISIONS_ADD_IDENTIFERS(
 			"developer.authorization.logDecisions.addIdentifiers", true),
 
 	/**
-	 * Enable the PolicyDecisionLogger.
+	 * Don't log policy decisions if the decision is INCONCLUSIVE.
 	 */
 	AUTHORIZATION_LOG_DECISIONS_SKIP_INCONCLUSIVE(
 			"developer.authorization.logDecisions.skipInconclusive", true),