You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2019/12/04 17:31:58 UTC
[isis] 03/06: ISIS-2213: slims down ConfigurationConstants
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 5ee0d14e86bc6d222ce91fa1dd0d3c8e23176f41
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Dec 4 15:59:01 2019 +0000
ISIS-2213: slims down ConfigurationConstants
---
.../apache/isis/config/ConfigurationConstants.java | 45 ++--------------------
.../ConfigUtil.java} | 38 +++++-------------
.../ConfigUtil_isProtected_Test.java} | 33 ++++++++--------
.../ConfigUtil_mask_Test.java} | 13 ++++---
.../confmenu/ConfigurationViewServiceDefault.java | 8 ++--
5 files changed, 41 insertions(+), 96 deletions(-)
diff --git a/core/config/src/main/java/org/apache/isis/config/ConfigurationConstants.java b/core/config/src/main/java/org/apache/isis/config/ConfigurationConstants.java
index 11bf3f3..c9780bc 100644
--- a/core/config/src/main/java/org/apache/isis/config/ConfigurationConstants.java
+++ b/core/config/src/main/java/org/apache/isis/config/ConfigurationConstants.java
@@ -19,6 +19,8 @@
package org.apache.isis.config;
+import lombok.experimental.UtilityClass;
+
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;
@@ -26,6 +28,7 @@ import java.util.function.Supplier;
import org.apache.isis.commons.internal.base._Strings;
import org.apache.isis.commons.internal.collections._Lists;
+@UtilityClass
public final class ConfigurationConstants {
public static final String LIST_SEPARATOR = ",";
@@ -33,49 +36,7 @@ public final class ConfigurationConstants {
public static final String ROOT_PREFIX = "isis";
public static final String ROOT = ROOT_PREFIX + DELIMITER;
-// public static final String DEFAULT_CONFIG_DIRECTORY = "config";
- public static final String WEBINF_DIRECTORY = "WEB-INF";
-// public static final String WEBINF_FULL_DIRECTORY = "src/main/webapp/" + WEBINF_DIRECTORY;
-
-// public static final String DEFAULT_CONFIG_FILE = "isis.properties";
-// public static final String WEB_CONFIG_FILE = "web.properties";
-
public static final List<String> PROTECTED_KEYS =
_Lists.of("password", "apiKey", "authToken");
- public static String maskIfProtected(final String key, final String value) {
- return isProtected(key) ? "********" : value;
- }
-
- public static Map<String, String> maskIfProtected(
- final Map<String, String> inMap,
- final Supplier<Map<String, String>> mapFactory) {
- final Map<String, String> result = mapFactory.get();
-
- inMap.forEach((k, v)->{
- result.put(k, maskIfProtected(k, v));
- });
-
- return result;
- }
-
- // -- HELPER
-
- private ConfigurationConstants() {}
-
- static boolean isProtected(final String key) {
- if(_Strings.isNullOrEmpty(key)) {
- return false;
- }
- final String toLowerCase = key.toLowerCase();
- for (String protectedKey : ConfigurationConstants.PROTECTED_KEYS) {
- if(toLowerCase.contains(protectedKey.toLowerCase())) {
- return true;
- }
- }
- return false;
- }
-
-
-
}
diff --git a/core/config/src/main/java/org/apache/isis/config/ConfigurationConstants.java b/core/config/src/main/java/org/apache/isis/config/util/ConfigUtil.java
similarity index 65%
copy from core/config/src/main/java/org/apache/isis/config/ConfigurationConstants.java
copy to core/config/src/main/java/org/apache/isis/config/util/ConfigUtil.java
index 11bf3f3..0a518b9 100644
--- a/core/config/src/main/java/org/apache/isis/config/ConfigurationConstants.java
+++ b/core/config/src/main/java/org/apache/isis/config/util/ConfigUtil.java
@@ -16,39 +16,21 @@
* specific language governing permissions and limitations
* under the License.
*/
+package org.apache.isis.config.util;
-package org.apache.isis.config;
+import lombok.experimental.UtilityClass;
-import java.util.List;
import java.util.Map;
import java.util.function.Supplier;
import org.apache.isis.commons.internal.base._Strings;
-import org.apache.isis.commons.internal.collections._Lists;
+import org.apache.isis.config.ConfigurationConstants;
-public final class ConfigurationConstants {
-
- public static final String LIST_SEPARATOR = ",";
- public static final String DELIMITER = ".";
- public static final String ROOT_PREFIX = "isis";
- public static final String ROOT = ROOT_PREFIX + DELIMITER;
-
-// public static final String DEFAULT_CONFIG_DIRECTORY = "config";
- public static final String WEBINF_DIRECTORY = "WEB-INF";
-// public static final String WEBINF_FULL_DIRECTORY = "src/main/webapp/" + WEBINF_DIRECTORY;
-
-// public static final String DEFAULT_CONFIG_FILE = "isis.properties";
-// public static final String WEB_CONFIG_FILE = "web.properties";
-
- public static final List<String> PROTECTED_KEYS =
- _Lists.of("password", "apiKey", "authToken");
-
- public static String maskIfProtected(final String key, final String value) {
- return isProtected(key) ? "********" : value;
- }
+@UtilityClass
+public class ConfigUtil {
public static Map<String, String> maskIfProtected(
- final Map<String, String> inMap,
+ final Map<String, String> inMap,
final Supplier<Map<String, String>> mapFactory) {
final Map<String, String> result = mapFactory.get();
@@ -59,9 +41,9 @@ public final class ConfigurationConstants {
return result;
}
- // -- HELPER
-
- private ConfigurationConstants() {}
+ public static String maskIfProtected(final String key, final String value) {
+ return isProtected(key) ? "********" : value;
+ }
static boolean isProtected(final String key) {
if(_Strings.isNullOrEmpty(key)) {
@@ -76,6 +58,4 @@ public final class ConfigurationConstants {
return false;
}
-
-
}
diff --git a/core/config/src/test/java/org/apache/isis/config/ConfigurationConstants_isProtected_Test.java b/core/config/src/test/java/org/apache/isis/config/util/ConfigUtil_isProtected_Test.java
similarity index 53%
rename from core/config/src/test/java/org/apache/isis/config/ConfigurationConstants_isProtected_Test.java
rename to core/config/src/test/java/org/apache/isis/config/util/ConfigUtil_isProtected_Test.java
index 8fa7333..cd7862c 100644
--- a/core/config/src/test/java/org/apache/isis/config/ConfigurationConstants_isProtected_Test.java
+++ b/core/config/src/test/java/org/apache/isis/config/util/ConfigUtil_isProtected_Test.java
@@ -16,51 +16,52 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.config;
+package org.apache.isis.config.util;
+import org.apache.isis.config.ConfigurationConstants;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
-public class ConfigurationConstants_isProtected_Test {
+public class ConfigUtil_isProtected_Test {
@Test
public void null_is_not() {
- assertFalse(ConfigurationConstants.isProtected(null));
+ assertFalse(ConfigUtil.isProtected(null));
- assertEquals("xxx", ConfigurationConstants.maskIfProtected(null, "xxx"));
+ assertEquals("xxx", ConfigUtil.maskIfProtected(null, "xxx"));
}
@Test
public void empty_is_not() {
- assertFalse(ConfigurationConstants.isProtected(""));
+ assertFalse(ConfigUtil.isProtected(""));
}
@Test
public void password_is() {
- assertTrue(ConfigurationConstants.isProtected("foo.PassWord.bar"));
- assertTrue(ConfigurationConstants.isProtected("password.bar"));
- assertTrue(ConfigurationConstants.isProtected("foo.PASSWORD"));
+ assertTrue(ConfigUtil.isProtected("foo.PassWord.bar"));
+ assertTrue(ConfigUtil.isProtected("password.bar"));
+ assertTrue(ConfigUtil.isProtected("foo.PASSWORD"));
- assertEquals("********", ConfigurationConstants.maskIfProtected("password", "xxx"));
+ assertEquals("********", ConfigUtil.maskIfProtected("password", "xxx"));
}
@Test
public void apiKey_is() {
- assertTrue(ConfigurationConstants.isProtected("foo.apiKey.bar"));
- assertTrue(ConfigurationConstants.isProtected("APIKEY.bar"));
- assertTrue(ConfigurationConstants.isProtected("foo.apikey"));
+ assertTrue(ConfigUtil.isProtected("foo.apiKey.bar"));
+ assertTrue(ConfigUtil.isProtected("APIKEY.bar"));
+ assertTrue(ConfigUtil.isProtected("foo.apikey"));
}
@Test
public void authToken_is() {
- assertTrue(ConfigurationConstants.isProtected("foo.authToken.bar"));
- assertTrue(ConfigurationConstants.isProtected("AUTHTOKEN.bar"));
- assertTrue(ConfigurationConstants.isProtected("foo.authtoken"));
+ assertTrue(ConfigUtil.isProtected("foo.authToken.bar"));
+ assertTrue(ConfigUtil.isProtected("AUTHTOKEN.bar"));
+ assertTrue(ConfigUtil.isProtected("foo.authtoken"));
}
@Test
public void otherwise_is_not() {
- assertFalse(ConfigurationConstants.isProtected("foo"));
+ assertFalse(ConfigUtil.isProtected("foo"));
}
}
\ No newline at end of file
diff --git a/core/config/src/test/java/org/apache/isis/config/ConfigurationConstants_mask_Test.java b/core/config/src/test/java/org/apache/isis/config/util/ConfigUtil_mask_Test.java
similarity index 70%
rename from core/config/src/test/java/org/apache/isis/config/ConfigurationConstants_mask_Test.java
rename to core/config/src/test/java/org/apache/isis/config/util/ConfigUtil_mask_Test.java
index 70abf68..7732d3f 100644
--- a/core/config/src/test/java/org/apache/isis/config/ConfigurationConstants_mask_Test.java
+++ b/core/config/src/test/java/org/apache/isis/config/util/ConfigUtil_mask_Test.java
@@ -16,34 +16,35 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.config;
+package org.apache.isis.config.util;
+import org.apache.isis.config.ConfigurationConstants;
import org.junit.Test;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertThat;
-public class ConfigurationConstants_mask_Test {
+public class ConfigUtil_mask_Test {
@Test
public void not_a_password() {
- assertThat(ConfigurationConstants.maskIfProtected("foo", "bar"), is(equalTo("bar")));
+ assertThat(ConfigUtil.maskIfProtected("foo", "bar"), is(equalTo("bar")));
}
@Test
public void a_password() {
- assertThat(ConfigurationConstants.maskIfProtected("xyz.password.abc", "bar"), is(equalTo("********")));
+ assertThat(ConfigUtil.maskIfProtected("xyz.password.abc", "bar"), is(equalTo("********")));
}
@Test
public void a_PassWord() {
- assertThat(ConfigurationConstants.maskIfProtected("xyz.PassWord.abc", "bar"), is(equalTo("********")));
+ assertThat(ConfigUtil.maskIfProtected("xyz.PassWord.abc", "bar"), is(equalTo("********")));
}
@Test
public void is_null() {
- assertThat(ConfigurationConstants.maskIfProtected(null, "bar"), is(equalTo("bar")));
+ assertThat(ConfigUtil.maskIfProtected(null, "bar"), is(equalTo("bar")));
}
}
\ No newline at end of file
diff --git a/core/runtime-services/src/main/java/org/apache/isis/runtime/services/confmenu/ConfigurationViewServiceDefault.java b/core/runtime-services/src/main/java/org/apache/isis/runtime/services/confmenu/ConfigurationViewServiceDefault.java
index 868da79..6d36274 100644
--- a/core/runtime-services/src/main/java/org/apache/isis/runtime/services/confmenu/ConfigurationViewServiceDefault.java
+++ b/core/runtime-services/src/main/java/org/apache/isis/runtime/services/confmenu/ConfigurationViewServiceDefault.java
@@ -35,6 +35,7 @@ import org.apache.isis.commons.internal.collections._Maps;
import org.apache.isis.commons.internal.environment.IsisSystemEnvironment;
import org.apache.isis.config.ConfigurationConstants;
import org.apache.isis.config.IsisConfiguration;
+import org.apache.isis.config.util.ConfigUtil;
import lombok.val;
import lombok.extern.log4j.Log4j2;
@@ -112,11 +113,12 @@ public class ConfigurationViewServiceDefault implements ConfigurationViewService
private static void add(String key, String value, Map<String, ConfigurationProperty> map) {
- value = ConfigurationConstants.maskIfProtected(key, value);
+ value = ConfigUtil.maskIfProtected(key, value);
map.put(key, new ConfigurationProperty(key, value));
}
-
-
+
+
+
}