Merge branch 'archive-custom-location' into 'main'

adding support for the non-replicated custom location to the archiveHelper tool

See merge request weblogic-cloud/weblogic-deploy-tooling!1665

Author: robertpatrick

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddCustomCommand.java

@@ -37,12 +37,18 @@ public class AddCustomCommand extends AddTypeCommandBase {
     )
     private String sourcePath;
 
+    @Option(
+        names = {"-use_non_replicable_location"},
+        description = "Place the content into the wlsdeploy/custom location instead of the default config/wlsdeploy/custom location"
+    )
+    private boolean useNonReplicableLocation;
+
     @Option(
         names = {"-path"},
         paramLabel = "<archive-path>",
         description = "Relative archive path from custom to the parent directory to use to add the file or directory, if any"
     )
-    private String archivePath = null;
+    private String archivePath;
 
     @Override
     public CommandResponse call() throws Exception {
@@ -57,16 +63,18 @@ public CommandResponse call() throws Exception {
             String resultName;
             if (this.overwrite) {
                 String archiveReplacementPath = "";
-                if (!StringUtils.isEmpty(archivePath)) {
+                if (!StringUtils.isEmpty(this.archivePath)) {
                     archiveReplacementPath = this.archivePath;
                     if (!archiveReplacementPath.endsWith(ZIP_SEP)) {
                         archiveReplacementPath += ZIP_SEP;
                     }
                 }
                 archiveReplacementPath += sourceFile.getName();
-                resultName = this.archive.replaceCustomEntry(archiveReplacementPath, sourceFile.getPath());
+                resultName = this.archive.replaceCustomEntry(archiveReplacementPath, sourceFile.getPath(),
+                    this.useNonReplicableLocation);
             } else {
-                resultName = this.archive.addCustomEntry(sourceFile.getPath(), this.archivePath);
+                resultName =
+                    this.archive.addCustomEntry(sourceFile.getPath(), this.archivePath, this.useNonReplicableLocation);
             }
             response = new CommandResponse(ExitCode.OK, resultName);
         } catch (ArchiveHelperException ex) {

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/extract/ExtractCustomCommand.java

@@ -33,6 +33,11 @@ public class ExtractCustomCommand extends ExtractTypeCommandBase {
     )
     private String name;
 
+    @Option(
+        names = {"-use_non_replicable_location"},
+        description = "Extract the contents from the wlsdeploy/custom location instead of the default config/wlsdeploy/custom location"
+    )
+    private boolean useNonReplicableLocation;
 
     @Override
     public CommandResponse call() throws Exception {
@@ -43,7 +48,7 @@ public CommandResponse call() throws Exception {
         try {
             initializeOptions();
 
-            this.archive.extractCustomEntry(this.name, this.targetDirectory);
+            this.archive.extractCustomEntry(this.name, this.targetDirectory, useNonReplicableLocation);
             response = new CommandResponse(ExitCode.OK, "WLSDPLY-30046", TYPE, this.name,
                 this.archiveFilePath, this.targetDirectory.getPath());
         } catch (ArchiveHelperException ex) {

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/list/ListCustomCommand.java

@@ -4,9 +4,15 @@
  */
 package oracle.weblogic.deploy.tool.archive_helper.list;
 
+import java.util.List;
+
 import oracle.weblogic.deploy.logging.PlatformLogger;
 import oracle.weblogic.deploy.logging.WLSDeployLogFactory;
+import oracle.weblogic.deploy.tool.archive_helper.ArchiveHelperException;
 import oracle.weblogic.deploy.tool.archive_helper.CommandResponse;
+import oracle.weblogic.deploy.util.ExitCode;
+import oracle.weblogic.deploy.util.StringUtils;
+import oracle.weblogic.deploy.util.WLSDeployArchiveIOException;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Option;
 
@@ -29,12 +35,44 @@ public class ListCustomCommand extends ListTypeCommandBase {
     )
     private String name;
 
+    @Option(
+        names = {"-use_non_replicable_location"},
+        description = "List the contents of the wlsdeploy/custom location instead of the default config/wlsdeploy/custom location"
+    )
+    private boolean useNonReplicableLocation;
+
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";
         LOGGER.entering(CLASS, METHOD);
 
-        CommandResponse response = listType(CUSTOM, "custom file or directory", name);
+        CommandResponse response;
+        boolean hasName = !StringUtils.isEmpty(this.name);
+        try {
+            initializeOptions(true);
+
+            List<String> archiveEntries;
+            if (hasName) {
+                archiveEntries = this.archive.listCustomEntries(name, useNonReplicableLocation);
+            } else {
+                archiveEntries = this.archive.listCustomEntries(useNonReplicableLocation);
+            }
+            response = new CommandResponse(ExitCode.OK);
+            response.addMessages(archiveEntries);
+        } catch (ArchiveHelperException ex) {
+            LOGGER.severe(ex.getLocalizedMessage(), ex);
+            response = new CommandResponse(ex.getExitCode(), ex.getLocalizedMessage());
+        } catch (WLSDeployArchiveIOException | IllegalArgumentException ex) {
+            if (hasName) {
+                LOGGER.severe("WLSDPLY-30005", ex, CUSTOM, name, archiveFilePath, ex.getLocalizedMessage());
+                response = new CommandResponse(ExitCode.ERROR, "WLSDPLY-30005", CUSTOM, name,
+                    this.archiveFilePath, ex.getLocalizedMessage());
+            } else {
+                LOGGER.severe("WLSDPLY-30006", ex, CUSTOM, this.archiveFilePath, ex.getLocalizedMessage());
+                response = new CommandResponse(ExitCode.ERROR, "WLSDPLY-30006", CUSTOM, this.archiveFilePath,
+                    ex.getLocalizedMessage());
+            }
+        }
 
         LOGGER.exiting(CLASS, METHOD, response);
         return response;

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/remove/RemoveCustomCommand.java

@@ -32,6 +32,12 @@ public class RemoveCustomCommand extends RemoveTypeCommandBase {
     )
     private String name;
 
+    @Option(
+        names = {"-use_non_replicable_location"},
+        description = "List the contents of the wlsdeploy/custom location instead of the default config/wlsdeploy/custom location"
+    )
+    private boolean useNonReplicableLocation;
+
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";
@@ -43,9 +49,9 @@ public CommandResponse call() throws Exception {
 
             int entriesRemoved;
             if (this.force) {
-                entriesRemoved = this.archive.removeCustomEntry(name, true);
+                entriesRemoved = this.archive.removeCustomEntry(name, useNonReplicableLocation, true);
             } else {
-                entriesRemoved = this.archive.removeCustomEntry(name);
+                entriesRemoved = this.archive.removeCustomEntry(name, useNonReplicableLocation);
             }
             response = new CommandResponse(ExitCode.OK, "WLSDPLY-30026", TYPE, this.name,
                 entriesRemoved, this.archiveFilePath);