Split meta and the thing

Author: cstamas

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/Dispatcher.java renamed to src/main/java/org/codehaus/plexus/components/secdispatcher/Dispatcher.java

@@ -11,13 +11,10 @@
  * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
  */
 
-package org.codehaus.plexus.components.secdispatcher.internal;
+package org.codehaus.plexus.components.secdispatcher;
 
 import java.util.Map;
 
-import org.codehaus.plexus.components.secdispatcher.DispatcherMeta;
-import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
-
 import static java.util.Objects.requireNonNull;
 
 /**
@@ -49,11 +46,6 @@ public String getEncrypted() {
         }
     }
 
-    /**
-     * The metadata of this dispatcher.
-     */
-    DispatcherMeta meta();
-
     /**
      * Encrypt given plaintext string. Implementation must return at least same attributes it got, but may add more
      * attributes to returned payload.

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/MasterSource.java renamed to src/main/java/org/codehaus/plexus/components/secdispatcher/MasterSource.java

@@ -11,27 +11,12 @@
  * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
  */
 
-package org.codehaus.plexus.components.secdispatcher.internal;
-
-import java.util.Optional;
-
-import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
+package org.codehaus.plexus.components.secdispatcher;
 
 /**
  * Source of master password.
  */
 public interface MasterSource {
-    /**
-     * String describing what this source does.
-     */
-    String description();
-
-    /**
-     * Optional "config template" that may serve as basis to configure this master source. The template cannot be
-     * "reused" as is as configuration.
-     */
-    Optional<String> configTemplate();
-
     /**
      * Handles the config to get master password. Implementation may do one of the following things:
      * <ul>

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

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2008 Sonatype, Inc. All rights reserved.
+ *
+ * This program is licensed to you under the Apache License Version 2.0,
+ * and you may not use this file except in compliance with the Apache License Version 2.0.
+ * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the Apache License Version 2.0 is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+ */
+
+package org.codehaus.plexus.components.secdispatcher;
+
+import java.util.Optional;
+
+/**
+ * Source of master password.
+ */
+public interface MasterSourceMeta {
+    /**
+     * String describing what this source does.
+     */
+    String description();
+
+    /**
+     * Optional "config template" that may serve as basis to configure this master source. The template cannot be
+     * "reused" as is as configuration.
+     */
+    Optional<String> configTemplate();
+}

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

@@ -20,7 +20,9 @@
 import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Collection;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
@@ -29,6 +31,7 @@
 
 import org.codehaus.plexus.components.cipher.PlexusCipher;
 import org.codehaus.plexus.components.cipher.PlexusCipherException;
+import org.codehaus.plexus.components.secdispatcher.Dispatcher;
 import org.codehaus.plexus.components.secdispatcher.DispatcherMeta;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcher;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
@@ -61,7 +64,31 @@ public DefaultSecDispatcher(
 
     @Override
     public Set<DispatcherMeta> availableDispatchers() {
-        return Set.copyOf(dispatchers.values().stream().map(Dispatcher::meta).collect(Collectors.toSet()));
+        return Set.copyOf(
+                dispatchers.entrySet().stream().map(this::dispatcherMeta).collect(Collectors.toSet()));
+    }
+
+    private DispatcherMeta dispatcherMeta(Map.Entry<String, Dispatcher> dispatcher) {
+        if (dispatcher instanceof DispatcherMeta) {
+            return (DispatcherMeta) dispatcher;
+        } else {
+            return new DispatcherMeta() {
+                @Override
+                public String name() {
+                    return dispatcher.getKey();
+                }
+
+                @Override
+                public String displayName() {
+                    return dispatcher.getKey() + " (needs manual configuration)";
+                }
+
+                @Override
+                public Collection<Field> fields() {
+                    return List.of();
+                }
+            };
+        }
     }
 
     @Override

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/dispatchers/MasterDispatcher.java

@@ -24,18 +24,19 @@
 
 import org.codehaus.plexus.components.cipher.PlexusCipher;
 import org.codehaus.plexus.components.cipher.PlexusCipherException;
+import org.codehaus.plexus.components.secdispatcher.Dispatcher;
 import org.codehaus.plexus.components.secdispatcher.DispatcherMeta;
+import org.codehaus.plexus.components.secdispatcher.MasterSource;
+import org.codehaus.plexus.components.secdispatcher.MasterSourceMeta;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcher;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
-import org.codehaus.plexus.components.secdispatcher.internal.Dispatcher;
-import org.codehaus.plexus.components.secdispatcher.internal.MasterSource;
 
 /**
  * This dispatcher is logically equivalent (but much more secure) that Maven3 "master password" encryption.
  */
 @Singleton
 @Named(MasterDispatcher.NAME)
-public class MasterDispatcher implements Dispatcher {
+public class MasterDispatcher implements Dispatcher, DispatcherMeta {
     public static final String NAME = "master";
 
     private static final String MASTER_CIPHER = "cipher";
@@ -51,48 +52,46 @@ public MasterDispatcher(PlexusCipher cipher, Map<String, MasterSource> masterSou
     }
 
     @Override
-    public DispatcherMeta meta() {
-        return new DispatcherMeta() {
-            @Override
-            public String name() {
-                return NAME;
-            }
+    public String name() {
+        return NAME;
+    }
 
-            @Override
-            public String displayName() {
-                return "Master Password Dispatcher";
-            }
+    @Override
+    public String displayName() {
+        return "Master Password Dispatcher";
+    }
 
-            @Override
-            public Collection<Field> fields() {
-                return List.of(
-                        Field.builder(MASTER_SOURCE)
-                                .optional(false)
-                                .description("The source of master password")
-                                .options(masterSources.entrySet().stream()
-                                        .map(e -> {
-                                            Field.Builder b = Field.builder(e.getKey())
-                                                    .description(e.getValue().description());
-                                            if (e.getValue().configTemplate().isPresent()) {
-                                                b = b.defaultValue(e.getValue()
-                                                        .configTemplate()
-                                                        .get());
-                                            }
-                                            return b.build();
-                                        })
-                                        .toList())
-                                .build(),
-                        Field.builder(MASTER_CIPHER)
-                                .optional(false)
-                                .description("The cipher to use with master password")
-                                .options(cipher.availableCiphers().stream()
-                                        .map(c -> Field.builder(c)
-                                                .description("Cipher implementation " + c)
-                                                .build())
-                                        .toList())
-                                .build());
-            }
-        };
+    @Override
+    public Collection<Field> fields() {
+        return List.of(
+                Field.builder(MASTER_SOURCE)
+                        .optional(false)
+                        .description("The source of master password")
+                        .options(masterSources.entrySet().stream()
+                                .map(e -> {
+                                    if (e instanceof MasterSourceMeta m) {
+                                        Field.Builder b =
+                                                Field.builder(e.getKey()).description(m.description());
+                                        if (m.configTemplate().isPresent()) {
+                                            b = b.defaultValue(
+                                                    m.configTemplate().get());
+                                        }
+                                        return b.build();
+                                    } else {
+                                        return Field.builder(e.getKey())
+                                                .description("Field not described (needs manual configuration)")
+                                                .build();
+                                    }
+                                })
+                                .toList())
+                        .build(),
+                Field.builder(MASTER_CIPHER)
+                        .optional(false)
+                        .description("The cipher to use with master password")
+                        .options(cipher.availableCiphers().stream()
+                                .map(c -> Field.builder(c).description(c).build())
+                                .toList())
+                        .build());
     }
 
     @Override

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/EnvMasterSource.java

@@ -23,6 +23,7 @@
 
 import java.util.Optional;
 
+import org.codehaus.plexus.components.secdispatcher.MasterSourceMeta;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
 
 /**
@@ -32,7 +33,7 @@
  */
 @Singleton
 @Named(EnvMasterSource.NAME)
-public final class EnvMasterSource extends PrefixMasterSourceSupport {
+public final class EnvMasterSource extends PrefixMasterSourceSupport implements MasterSourceMeta {
     public static final String NAME = "env";
 
     public EnvMasterSource() {

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/GpgAgentMasterSource.java

@@ -34,6 +34,7 @@
 import java.util.HexFormat;
 import java.util.Optional;
 
+import org.codehaus.plexus.components.secdispatcher.MasterSourceMeta;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
 
 /**
@@ -43,7 +44,7 @@
  */
 @Singleton
 @Named(GpgAgentMasterSource.NAME)
-public final class GpgAgentMasterSource extends PrefixMasterSourceSupport {
+public final class GpgAgentMasterSource extends PrefixMasterSourceSupport implements MasterSourceMeta {
     public static final String NAME = "gpg-agent";
 
     public GpgAgentMasterSource() {

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/MasterSourceSupport.java

@@ -21,8 +21,8 @@
 import java.util.function.Function;
 import java.util.function.Predicate;
 
+import org.codehaus.plexus.components.secdispatcher.MasterSource;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
-import org.codehaus.plexus.components.secdispatcher.internal.MasterSource;
 
 import static java.util.Objects.requireNonNull;
 

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/SystemPropertyMasterSource.java

@@ -23,6 +23,7 @@
 
 import java.util.Optional;
 
+import org.codehaus.plexus.components.secdispatcher.MasterSourceMeta;
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
 
 /**
@@ -32,7 +33,7 @@
  */
 @Singleton
 @Named(SystemPropertyMasterSource.NAME)
-public final class SystemPropertyMasterSource extends PrefixMasterSourceSupport {
+public final class SystemPropertyMasterSource extends PrefixMasterSourceSupport implements MasterSourceMeta {
     public static final String NAME = "system-property";
 
     public SystemPropertyMasterSource() {