Add javadoc

Author: cstamas

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

@@ -22,8 +22,24 @@
  * @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".
+     */
     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.
+     *
+     * @see #availableDispatchers()
+     */
     String DISPATCHER_NAME_ATTR = "name";
 
     /**

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

@@ -17,6 +17,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
 import java.util.Map;
+import java.util.Set;
 
 import org.codehaus.plexus.components.cipher.internal.DefaultPlexusCipher;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcher;
@@ -148,6 +149,7 @@ void testEncryptWithDispatcher() throws Exception {
                 Map.of("magic", new StaticDispatcher("decrypted", "encrypted")),
                 DefaultSecDispatcher.DEFAULT_CONFIGURATION);
 
+        assertEquals(Set.of("magic"), sd.availableDispatchers());
         String enc = sd.encrypt("whatever", Map.of(SecDispatcher.DISPATCHER_NAME_ATTR, "magic", "a", "b"));
         assertNotNull(enc);
         assertTrue(enc.contains("encrypted"));
@@ -164,6 +166,7 @@ void testDecryptWithDispatcher() throws Exception {
                 Map.of("magic", new StaticDispatcher("decrypted", "encrypted")),
                 DefaultSecDispatcher.DEFAULT_CONFIGURATION);
 
+        assertEquals(Set.of("magic"), sd.availableDispatchers());
         String pass = sd.decrypt("{" + Base64.getEncoder().encodeToString("whatever".getBytes(StandardCharsets.UTF_8))
                 + "[a=b," + SecDispatcher.DISPATCHER_NAME_ATTR + "=magic]}");
         assertNotNull(pass);