GEODE-5010: Introduce *ResultModel objects to replace *ResultData (apache#1870)

- The changes here are intended to allow for support of both the old and new
  model for producing results. As such the interface structures are a mess but
  will be cleaned up once all commands have been converted.
- Not all types of return values are supported but will be added as commands
  are converted. In particular commands that return actual result data in the
  form of files or file content.
- Sub-sections are not supported anymore.
- All commands should now return a ResultModel object

Author: jdeppe-pivotal

geode-core/src/main/java/org/apache/geode/management/internal/beans/MemberMBeanBridge.java

@@ -98,7 +98,6 @@
 import org.apache.geode.management.GemFireProperties;
 import org.apache.geode.management.JVMMetrics;
 import org.apache.geode.management.OSMetrics;
-import org.apache.geode.management.cli.Result;
 import org.apache.geode.management.internal.ManagementConstants;
 import org.apache.geode.management.internal.ManagementStrings;
 import org.apache.geode.management.internal.SystemManagementService;
@@ -115,6 +114,7 @@
 import org.apache.geode.management.internal.cli.CommandResponseBuilder;
 import org.apache.geode.management.internal.cli.remote.OnlineCommandProcessor;
 import org.apache.geode.management.internal.cli.result.CommandResult;
+import org.apache.geode.management.internal.cli.result.model.ResultModel;
 
 /**
  * This class acts as an Bridge between MemberMBean and GemFire Cache and Distributed System
@@ -1511,8 +1511,13 @@ public String processCommand(String commandString, Map<String, String> env,
               + commandServiceInitError);
     }
 
-    Result result = commandProcessor.executeCommand(commandString, env, stagedFilePaths);
-    return CommandResponseBuilder.createCommandResponseJson(getMember(), (CommandResult) result);
+    Object result = commandProcessor.executeCommand(commandString, env, stagedFilePaths);
+
+    if (result instanceof CommandResult) {
+      return CommandResponseBuilder.createCommandResponseJson(getMember(), (CommandResult) result);
+    } else {
+      return CommandResponseBuilder.createCommandResponseJson(getMember(), (ResultModel) result);
+    }
   }
 
   public long getTotalDiskUsage() {

geode-core/src/main/java/org/apache/geode/management/internal/cli/CliAroundInterceptor.java

@@ -32,7 +32,7 @@ public interface CliAroundInterceptor {
   /**
    * called by the OperationInvoker before the command is executed
    */
-  default Result preExecution(GfshParseResult parseResult) {
+  default Object preExecution(GfshParseResult parseResult) {
     return ResultBuilder.createInfoResult("");
   }
 

geode-core/src/main/java/org/apache/geode/management/internal/cli/CommandResponse.java

@@ -19,6 +19,7 @@
 
 import org.apache.geode.internal.GemFireVersion;
 import org.apache.geode.management.internal.cli.json.GfJsonObject;
+import org.apache.geode.management.internal.cli.result.ResultData;
 
 /**
  * @since GemFire 7.0
@@ -33,16 +34,10 @@ public class CommandResponse {
   private final String when;
   private final String tokenAccessor;
   private final String debugInfo;
-  private final Data data;
+  private final ResultData data;
   private final boolean failedToPersist;
   private final String fileToDownload;
-
-  CommandResponse(String sender, String contentType, int status, String page, String tokenAccessor,
-      String debugInfo, String header, GfJsonObject content, String footer,
-      boolean failedToPersist) {
-    this(sender, contentType, status, page, tokenAccessor, debugInfo, header, content, footer,
-        failedToPersist, null);
-  }
+  private final boolean isLegacy;
 
   CommandResponse(String sender, String contentType, int status, String page, String tokenAccessor,
       String debugInfo, String header, GfJsonObject content, String footer, boolean failedToPersist,
@@ -53,7 +48,7 @@ public class CommandResponse {
     this.page = page;
     this.tokenAccessor = tokenAccessor;
     this.debugInfo = debugInfo;
-    this.data = new Data(header, content, footer);
+    this.data = new LegacyData(header, content, footer);
     this.when = DateFormat.getInstance().format(new java.util.Date());
     this.version = GemFireVersion.getGemFireVersion();
     this.failedToPersist = failedToPersist;
@@ -62,6 +57,7 @@ public class CommandResponse {
     } else {
       this.fileToDownload = null;
     }
+    this.isLegacy = true;
   }
 
   // For de-serializing
@@ -72,11 +68,12 @@ public class CommandResponse {
     this.page = jsonObject.getString("page");
     this.tokenAccessor = jsonObject.getString("tokenAccessor");
     this.debugInfo = jsonObject.getString("debugInfo");
-    this.data = new Data(jsonObject.getJSONObject("data"));
+    this.data = new LegacyData(jsonObject.getJSONObject("data"));
     this.when = jsonObject.getString("when");
     this.version = jsonObject.getString("version");
     this.failedToPersist = jsonObject.getBoolean("failedToPersist");
     this.fileToDownload = jsonObject.getString("fileToDownload");
+    this.isLegacy = true;
   }
 
   /**
@@ -135,7 +132,7 @@ public String getTokenAccessor() {
   /**
    * @return the data
    */
-  public Data getData() {
+  public ResultData getData() {
     return data;
   }
 
@@ -150,18 +147,22 @@ public boolean isFailedToPersist() {
     return failedToPersist;
   }
 
-  public static class Data {
+  public boolean isLegacy() {
+    return isLegacy;
+  }
+
+  public static class LegacyData implements ResultData {
     private String header;
     private GfJsonObject content;
     private String footer;
 
-    public Data(String header, GfJsonObject content, String footer) {
+    public LegacyData(String header, GfJsonObject content, String footer) {
       this.header = header;
       this.content = content;
       this.footer = footer;
     }
 
-    public Data(GfJsonObject dataJsonObject) {
+    public LegacyData(GfJsonObject dataJsonObject) {
       this.header = dataJsonObject.getString("header");
       this.content = dataJsonObject.getJSONObject("content");
       this.footer = dataJsonObject.getString("footer");
@@ -195,46 +196,5 @@ public String toString() {
       return builder.toString();
     }
   }
-}
-
 
-/*
- ** TABLE
- *
- * { "sender": "member1", "version": "gemfire70", "contentType": "table", "page": "1/1",
- * "tokenAccessor": "__NULL__", "status": "OK", "when": "January 12 2012", "debugData": [ "val1",
- * "val2" ], "data": { "header": [ "Header1", "Header2", "Header3", "Header4" ], "content": [ [
- * "val00", "val01", "val02", "val03" ], [ "val10", "val11", "val12", "val13" ], [ "val20", "val21",
- * "val22", "val23" ] ] } }
- **
- * TABLE SCROLLABLE
- *
- * { "sender": "member1", "version": "gemfire70", "contentType": "table", "page": "1/5",
- * "tokenHolder": "TOKEN12345", "status": "OK", "when": "January 12 2012", "debugData": [ "val1",
- * "val2" ], "data": { "header": [ "Header1", "Header2", "Header3", "Header4" ], "content": [ [
- * "val00", "val01", "val02", "val03" ], [ "val10", "val11", "val12", "val13" ], [ "val20", "val21",
- * "val22", "val23" ] ] } }
- **
- *
- * CATALOG
- *
- * { "sender": "member1", "version": "gemfire70", "contentType": "catalog", "page": "1/1",
- * "tokenHolder": "__NULL__", "status": "OK", "when": "January 12 2012", "debugData": [ "val1",
- * "val2" ], "data": { "content": [ { "key1": "val1", "key2": "val2", "key3": "val3", "key4":
- * "val4", "key5": "val5", "key6": "val6", "key7": "val7" } ] } }
- **
- *
- * CATALOG SCROLLABLE
- *
- * { "sender": "member1", "version": "gemfire70", "contentType": "catalog", "page": "1/10",
- * "tokenHolder": "TOKEN1265765", "status": "OK", "when": "January 12 2012", "debugData": [ "val1",
- * "val2" ], "data": { "content": [ { "key1": "val1", "key2": "val2", "key3": "val3", "key4":
- * "val4", "key5": "val5", "key6": "val6", "key7": "val7" } ] } }
- **
- *
- * Object as argument
- *
- * { "com.foo.bar.Employee": { "id": 1234, "name": "Foo BAR", "department": { "id": 456, "name":
- * "support" } } }
- *
- */
+}

geode-core/src/main/java/org/apache/geode/management/internal/cli/CommandResponseBuilder.java

@@ -14,25 +14,28 @@
  */
 package org.apache.geode.management.internal.cli;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.apache.commons.lang.exception.ExceptionUtils;
 
 import org.apache.geode.management.cli.CliMetaData;
 import org.apache.geode.management.internal.cli.json.GfJsonException;
 import org.apache.geode.management.internal.cli.json.GfJsonObject;
 import org.apache.geode.management.internal.cli.remote.CommandExecutionContext;
 import org.apache.geode.management.internal.cli.result.CommandResult;
+import org.apache.geode.management.internal.cli.result.model.ResultModel;
 
 /**
  *
  * @since GemFire 7.0
  */
 public class CommandResponseBuilder {
 
-  public static CommandResponse prepareCommandResponse(String memberName, CommandResult result) {
+  private static CommandResponse prepareCommandResponse(String memberName, CommandResult result) {
     GfJsonObject content;
     content = result.getContent();
     return new CommandResponse(memberName, getType(result), result.getStatus().getCode(), "1/1",
-        CliMetaData.ANNOTATION_NULL_VALUE, getDebugInfo(result), result.getHeader(), content,
+        CliMetaData.ANNOTATION_NULL_VALUE, getDebugInfo(), result.getHeader(), content,
         result.getFooter(), result.failedToPersist(), result.getFileToDownload());
   }
 
@@ -47,19 +50,30 @@ public static CommandResponse prepareCommandResponseFromJson(String jsonString)
     return new CommandResponse(jsonObject);
   }
 
-  public static String getCommandResponseJson(CommandResponse commandResponse) {
+  private static String getCommandResponseJson(CommandResponse commandResponse) {
     return new GfJsonObject(commandResponse).toString();
   }
 
   public static String createCommandResponseJson(String memberName, CommandResult result) {
     return getCommandResponseJson(prepareCommandResponse(memberName, result));
   }
 
+  public static String createCommandResponseJson(String memberName, ResultModel result) {
+    ObjectMapper mapper = new ObjectMapper();
+
+    try {
+      String json = mapper.writeValueAsString(result);
+      return json;
+    } catch (JsonProcessingException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
   private static String getType(CommandResult result) {
     return result.getType();
   }
 
-  private static String getDebugInfo(CommandResult result) {
+  private static String getDebugInfo() {
     String debugInfo = "";
     if (CommandExecutionContext.isSetWrapperThreadLocal()) {
       CommandResponseWriter responseWriter = CommandExecutionContext.getCommandResponseWriter();

geode-core/src/main/java/org/apache/geode/management/internal/cli/commands/AlterAsyncEventQueueCommand.java

@@ -36,12 +36,11 @@
 import org.apache.geode.cache.Region;
 import org.apache.geode.distributed.internal.InternalClusterConfigurationService;
 import org.apache.geode.management.cli.CliMetaData;
-import org.apache.geode.management.cli.Result;
 import org.apache.geode.management.internal.cli.AbstractCliAroundInterceptor;
 import org.apache.geode.management.internal.cli.GfshParseResult;
 import org.apache.geode.management.internal.cli.exceptions.EntityNotFoundException;
-import org.apache.geode.management.internal.cli.result.ResultBuilder;
-import org.apache.geode.management.internal.cli.result.TabularResultData;
+import org.apache.geode.management.internal.cli.result.model.ResultModel;
+import org.apache.geode.management.internal.cli.result.model.TabularResultModel;
 import org.apache.geode.management.internal.configuration.domain.Configuration;
 import org.apache.geode.management.internal.configuration.utils.XmlUtils;
 import org.apache.geode.management.internal.security.ResourceOperation;
@@ -74,7 +73,7 @@ public class AlterAsyncEventQueueCommand extends InternalGfshCommand {
       interceptor = "org.apache.geode.management.internal.cli.commands.AlterAsyncEventQueueCommand$Interceptor")
   @ResourceOperation(resource = ResourcePermission.Resource.CLUSTER,
       operation = ResourcePermission.Operation.MANAGE, target = ResourcePermission.Target.DEPLOY)
-  public Result execute(@CliOption(key = ID, mandatory = true, help = ID_HELP) String id,
+  public ResultModel execute(@CliOption(key = ID, mandatory = true, help = ID_HELP) String id,
       @CliOption(key = BATCH_SIZE, help = BATCH_SIZE_HELP) Integer batchSize,
       @CliOption(key = BATCH_TIME_INTERVAL,
           help = BATCH_TIME_INTERVAL_HELP) Integer batchTimeInterval,
@@ -83,22 +82,25 @@ public Result execute(@CliOption(key = ID, mandatory = true, help = ID_HELP) Str
           unspecifiedDefaultValue = "false") boolean ifExists)
       throws IOException, SAXException, ParserConfigurationException, TransformerException {
 
+    ResultModel result = new ResultModel();
+
     // need not check if any running servers has this async-event-queue. A server with this queue id
     // may be shutdown, but we still need to update Cluster Configuration.
     InternalClusterConfigurationService service =
         (InternalClusterConfigurationService) getConfigurationService();
 
     if (service == null) {
-      return ResultBuilder.createUserErrorResult("Cluster Configuration Service is not available. "
+      return result.createError("Cluster Configuration Service is not available. "
           + "Please connect to a locator with running Cluster Configuration Service.");
     }
 
     boolean locked = service.lockSharedConfiguration();
     if (!locked) {
-      return ResultBuilder.createGemFireErrorResult("Unable to lock the cluster configuration.");
+      return result.createCommandProcessingError("Unable to lock the cluster configuration.");
     }
 
-    TabularResultData tableData = ResultBuilder.createTabularResultData();
+    TabularResultModel tableData = result.addTable();
+    boolean xmlUpdated = false;
     try {
       Region<String, Configuration> configRegion = service.getConfigurationRegion();
       for (String group : configRegion.keySet()) {
@@ -108,7 +110,6 @@ public Result execute(@CliOption(key = ID, mandatory = true, help = ID_HELP) Str
           continue;
         }
 
-        boolean xmlUpdated = false;
         Document document = XmlUtils.createDocumentFromXml(config.getCacheXmlContent());
         NodeList nodeList = document.getElementsByTagName("async-event-queue");
         for (int i = 0; i < nodeList.getLength(); i++) {
@@ -145,7 +146,7 @@ public Result execute(@CliOption(key = ID, mandatory = true, help = ID_HELP) Str
       service.unlockSharedConfiguration();
     }
 
-    if (tableData.rowSize("Group") == 0) {
+    if (!xmlUpdated) {
       String message = String.format("Can not find an async event queue with id '%s'.", id);
       throw new EntityNotFoundException(message, ifExists);
     }
@@ -154,21 +155,22 @@ public Result execute(@CliOption(key = ID, mandatory = true, help = ID_HELP) Str
     tableData.setFooter(System.lineSeparator()
         + "These changes won't take effect on the running servers. " + System.lineSeparator()
         + "Please restart the servers in these groups for the changes to take effect.");
-    return ResultBuilder.buildResult(tableData);
+
+    return result;
   }
 
   public static class Interceptor extends AbstractCliAroundInterceptor {
     @Override
-    public Result preExecution(GfshParseResult parseResult) {
+    public ResultModel preExecution(GfshParseResult parseResult) {
       Object batchSize = parseResult.getParamValue(BATCH_SIZE);
       Object batchTimeInterval = parseResult.getParamValue(BATCH_TIME_INTERVAL);
       Object maxQueueMemory = parseResult.getParamValue(MAX_QUEUE_MEMORY);
 
+      ResultModel resultModel = new ResultModel();
       if (batchSize == null && batchTimeInterval == null && maxQueueMemory == null) {
-        return ResultBuilder
-            .createUserErrorResult("need to specify at least one option to modify.");
+        resultModel.createError("need to specify at least one option to modify.");
       }
-      return ResultBuilder.createInfoResult("");
+      return resultModel;
     }
   }
 }