Simplify it more

Do not provide "bad" and "never used" defaults as before as it
was just the source of confusion, as old component had to be
"redefined" in Plexus XML or alike anyway, to be usable in Maven.

Author: cstamas

src/main/java/org/codehaus/plexus/components/secdispatcher/SecDispatcher.java

@@ -25,19 +25,6 @@
  * @author Oleg Gusakov
  */
 public interface SecDispatcher {
-    /**
-     * The default path of configuration.
-     * <p>
-     * The character {@code ~} (tilde) may be present as first character ONLY and is
-     * interpreted as "user.home" system property, and it MUST be followed by path separator.
-     */
-    String DEFAULT_CONFIGURATION = "~/.m2/settings-security.xml";
-
-    /**
-     * Java System Property that may be set, to override configuration path.
-     */
-    String SYSTEM_PROPERTY_CONFIGURATION_LOCATION = "settings.security";
-
     /**
      * Attribute that selects a dispatcher.
      *
@@ -58,7 +45,7 @@ public interface SecDispatcher {
      * @return encrypted string
      * @throws SecDispatcherException in case of problem
      */
-    String encrypt(String str, Map<String, String> attr) throws SecDispatcherException;
+    String encrypt(String str, Map<String, String> attr) throws SecDispatcherException, IOException;
 
     /**
      * Decrypt given encrypted string.
@@ -67,7 +54,7 @@ public interface SecDispatcher {
      * @return decrypted string
      * @throws SecDispatcherException in case of problem
      */
-    String decrypt(String str) throws SecDispatcherException;
+    String decrypt(String str) throws SecDispatcherException, IOException;
 
     /**
      * Reads the effective configuration, eventually creating new instance if not present.

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/DefaultSecDispatcher.java

@@ -13,13 +13,9 @@
 
 package org.codehaus.plexus.components.secdispatcher.internal;
 
-import javax.inject.Inject;
-import javax.inject.Named;
-import javax.inject.Singleton;
-
 import java.io.IOException;
+import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
@@ -40,26 +36,33 @@
 import static java.util.Objects.requireNonNull;
 
 /**
+ * Note: this implementation is NOT a JSR330 component. Integrating apps anyway want to customize it (at least
+ * the name and location of configuration file), so instead as before (providing "bad" configuration file just
+ * to have one), it is the duty of integrator to wrap and "finish" the implementation in a way it suits the
+ * integrator. Also, using "globals" like Java System Properties are bad thing, and it is integrator who knows
+ * what is needed anyway.
+ * <p>
+ * Recommended way for integration is to create JSR330 {@link javax.inject.Provider}.
+ *
  * @author Oleg Gusakov
  */
-@Singleton
-@Named
 public class DefaultSecDispatcher implements SecDispatcher {
     public static final String ATTR_START = "[";
     public static final String ATTR_STOP = "]";
 
     protected final PlexusCipher cipher;
     protected final Map<String, Dispatcher> dispatchers;
-    protected final String configurationFile;
+    protected final Path configurationFile;
 
-    @Inject
-    public DefaultSecDispatcher(
-            PlexusCipher cipher,
-            Map<String, Dispatcher> dispatchers,
-            @Named("${configurationFile:-" + DEFAULT_CONFIGURATION + "}") final String configurationFile) {
+    public DefaultSecDispatcher(PlexusCipher cipher, Map<String, Dispatcher> dispatchers, Path configurationFile) {
         this.cipher = requireNonNull(cipher);
         this.dispatchers = requireNonNull(dispatchers);
         this.configurationFile = requireNonNull(configurationFile);
+
+        // file may or may not exist, but one thing is certain: it cannot be an exiting directory
+        if (Files.isDirectory(configurationFile)) {
+            throw new IllegalArgumentException("configurationFile cannot be a directory");
+        }
     }
 
     @Override
@@ -94,7 +97,7 @@ public Collection<Field> fields() {
     }
 
     @Override
-    public String encrypt(String str, Map<String, String> attr) throws SecDispatcherException {
+    public String encrypt(String str, Map<String, String> attr) throws SecDispatcherException, IOException {
         if (isEncryptedString(str)) return str;
 
         try {
@@ -130,7 +133,7 @@ public String encrypt(String str, Map<String, String> attr) throws SecDispatcher
     }
 
     @Override
-    public String decrypt(String str) throws SecDispatcherException {
+    public String decrypt(String str) throws SecDispatcherException, IOException {
         if (!isEncryptedString(str)) return str;
         try {
             String bare = cipher.unDecorate(str);
@@ -149,7 +152,7 @@ public String decrypt(String str) throws SecDispatcherException {
 
     @Override
     public SettingsSecurity readConfiguration(boolean createIfMissing) throws IOException {
-        SettingsSecurity configuration = SecUtil.read(getConfigurationPath());
+        SettingsSecurity configuration = SecUtil.read(configurationFile);
         if (configuration == null && createIfMissing) {
             configuration = new SettingsSecurity();
         }
@@ -159,10 +162,10 @@ public SettingsSecurity readConfiguration(boolean createIfMissing) throws IOExce
     @Override
     public void writeConfiguration(SettingsSecurity configuration) throws IOException {
         requireNonNull(configuration, "configuration is null");
-        SecUtil.write(getConfigurationPath(), configuration, true);
+        SecUtil.write(configurationFile, configuration, true);
     }
 
-    private Map<String, String> prepareDispatcherConfig(String type) {
+    protected Map<String, String> prepareDispatcherConfig(String type) throws IOException {
         HashMap<String, String> dispatcherConf = new HashMap<>();
         Map<String, String> conf = SecUtil.getConfig(getConfiguration(), type);
         if (conf != null) {
@@ -171,7 +174,7 @@ private Map<String, String> prepareDispatcherConfig(String type) {
         return dispatcherConf;
     }
 
-    private String strip(String str) {
+    protected String strip(String str) {
         int start = str.indexOf(ATTR_START);
         int stop = str.indexOf(ATTR_STOP);
         if (start != -1 && stop != -1 && stop > start) {
@@ -180,7 +183,7 @@ private String strip(String str) {
         return str;
     }
 
-    private Map<String, String> stripAttributes(String str) {
+    protected Map<String, String> stripAttributes(String str) {
         HashMap<String, String> result = new HashMap<>();
         int start = str.indexOf(ATTR_START);
         int stop = str.indexOf(ATTR_STOP);
@@ -202,30 +205,12 @@ private Map<String, String> stripAttributes(String str) {
         return result;
     }
 
-    private boolean isEncryptedString(String str) {
+    protected boolean isEncryptedString(String str) {
         if (str == null) return false;
         return cipher.isEncryptedString(str);
     }
 
-    private Path getConfigurationPath() {
-        String location = System.getProperty(SYSTEM_PROPERTY_CONFIGURATION_LOCATION, getConfigurationFile());
-        location = location.charAt(0) == '~' ? System.getProperty("user.home") + location.substring(1) : location;
-        return Paths.get(location);
-    }
-
-    private SettingsSecurity getConfiguration() throws SecDispatcherException {
-        Path path = getConfigurationPath();
-        try {
-            SettingsSecurity sec = SecUtil.read(path);
-            if (sec == null)
-                throw new SecDispatcherException("Please check that configuration file on path " + path + " exists");
-            return sec;
-        } catch (IOException e) {
-            throw new SecDispatcherException(e.getMessage(), e);
-        }
-    }
-
-    public String getConfigurationFile() {
-        return configurationFile;
+    protected SettingsSecurity getConfiguration() throws SecDispatcherException, IOException {
+        return SecUtil.read(configurationFile);
     }
 }

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/SecUtil.java

@@ -20,7 +20,6 @@
 import java.io.OutputStream;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
-import java.nio.file.NoSuchFileException;
 import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
 import java.util.HashMap;
@@ -58,8 +57,6 @@ public static SettingsSecurity read(Path configurationFile) throws IOException {
                 sec = new SecurityConfigurationStaxReader().read(in);
             }
             return sec;
-        } catch (NoSuchFileException e) {
-            return null;
         } catch (XMLStreamException e) {
             throw new IOException("Parsing error", e);
         }

src/test/java/org/codehaus/plexus/components/secdispatcher/internal/DefaultSecDispatcherTest.java

@@ -16,6 +16,7 @@
 import java.io.OutputStream;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
+import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Map;
 
@@ -36,6 +37,8 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class DefaultSecDispatcherTest {
+    private final Path CONFIG_PATH = Paths.get("./target/sec.xml");
+
     private void saveSec(String dispatcher, Map<String, String> config) throws Exception {
         SettingsSecurity sec = new SettingsSecurity();
         sec.setModelEncoding(StandardCharsets.UTF_8.name());
@@ -56,10 +59,9 @@ private void saveSec(SettingsSecurity sec) throws Exception {
         sec.setModelEncoding(StandardCharsets.UTF_8.name());
         sec.setModelVersion(SecDispatcher.class.getPackage().getSpecificationVersion());
 
-        try (OutputStream fos = Files.newOutputStream(Paths.get("./target/sec.xml"))) {
+        try (OutputStream fos = Files.newOutputStream(CONFIG_PATH)) {
             new SecurityConfigurationStaxWriter().write(fos, sec);
         }
-        System.setProperty(DefaultSecDispatcher.SYSTEM_PROPERTY_CONFIGURATION_LOCATION, "./target/sec.xml");
     }
 
     @Test
@@ -74,7 +76,7 @@ void masterWithSystemPropertyRoundTrip() throws Exception {
         roundtrip();
     }
 
-    protected void roundtrip() {
+    protected void roundtrip() throws Exception {
         DefaultSecDispatcher sd = construct();
 
         assertEquals(1, sd.availableDispatchers().size());
@@ -104,6 +106,6 @@ protected DefaultSecDispatcher construct() {
                                         new SystemPropertyMasterSource(),
                                         GpgAgentMasterSource.NAME,
                                         new GpgAgentMasterSource()))),
-                DefaultSecDispatcher.DEFAULT_CONFIGURATION);
+                CONFIG_PATH);
     }
 }