[TUBEMQ-439]Add Cli field Scheme definition

pom.xml

@@ -312,7 +312,7 @@
             <dependency>
                 <groupId>commons-cli</groupId>
                 <artifactId>commons-cli</artifactId>
-                <version>1.2</version>
+                <version>1.4</version>
             </dependency>
             <dependency>
                 <groupId>commons-codec</groupId>

tubemq-server/src/main/java/org/apache/tubemq/server/broker/web/BrokerAdminServlet.java

@@ -30,9 +30,9 @@
 import org.apache.tubemq.server.broker.msgstore.MessageStoreManager;
 import org.apache.tubemq.server.broker.nodeinfo.ConsumerNodeInfo;
 import org.apache.tubemq.server.broker.offset.OffsetService;
+import org.apache.tubemq.server.common.fielddef.WebFieldDef;
 import org.apache.tubemq.server.common.utils.ProcessResult;
 import org.apache.tubemq.server.common.utils.WebParameterUtils;
-import org.apache.tubemq.server.common.webbase.WebFieldDef;
 
 /***
  * Broker's web servlet. Used for admin operation, like query consumer's status etc.

tubemq-server/src/main/java/org/apache/tubemq/server/common/fielddef/CliArgDef.java

@@ -0,0 +1,111 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.tubemq.server.common.fielddef;
+
+
+
+public enum CliArgDef {
+
+    // Note: Due to compatibility considerations,
+    //      the defined fields in the scheme are forbidden to be modified,
+    //      only new fields can be added
+
+    HELP("h", "help", "Print usage information."),
+    VERSION("v", "version", "Display TubeMQ version."),
+    MASTERSERVER("master-servers", "master-servers",
+            "String: format is master1_ip:port[,master2_ip:port]",
+            "The master address(es) to connect to."),
+    MASTERURL("master-url", "master-url",
+            "String: format is http://master_ip:master_webport/",
+            "Master Service URL to which to connect.(default: http://localhost:8080/)"),
+    BROKERURL("broker-url", "broker-url",
+            "String: format is http://broker_ip:broker_webport/",
+            "Broker Service URL to which to connect.(default: http://localhost:8081/)"),
+    MESSAGES("messages", "messages",
+            "Long: count",
+            "The number of messages to send or consume, If not set, production or consumption is continual."),
+    MSGDATASIZE("msg-data-size", "message-data-size",
+            "Int: message size",
+            "message's data size in bytes. Note that you must provide exactly"
+                    + " one of --msg-data-size or --payload-file."),
+    PAYLOADFILE("payload-file", "payload-file",
+            "String: payload file path",
+            "file to read the message payloads from. This works only for"
+                    + " UTF-8 encoded text files. Payloads will be read from this"
+                    + " file and a payload will be randomly selected when sending"
+                    + " messages. Note that you must provide exactly one"
+                    + " of --msg-data-size or --payload-file."),
+    PAYLOADDELIM("payload-delimiter", "payload-delimiter",
+            "String: payload data's delimiter",
+            "provides delimiter to be used when --payload-file is provided."
+                    + " Defaults to new line. Note that this parameter will be"
+                    + " ignored if --payload-file is not provided. (default: \\n)"),
+    PRDTOPIC("topic", "topicName",
+            "String: topic, format is topic_1[,topic_2[:filterCond_2.1[;filterCond_2.2]]]",
+            "The topic(s) to produce messages to."),
+    CNSTOPIC("topic", "topicName",
+            "String: topic, format is topic_1[[:filterCond_1.1[;filterCond_1.2]][,topic_2]]",
+            "The topic(s) to consume on."),
+    RPCTIMEOUT("timeout", "timeout",
+            "Long: milliseconds",
+            "The maximum duration between request and response in milliseconds. (default: 10000)"),
+    GROUP("group", "groupName",
+            "String: consumer group",
+            "The consumer group name of the consumer."),
+    CLIENTCOUNT("client-num", "client-num",
+            "Int: client count",
+            "Number of consumers to started."),
+    PULLMODEL("pull-model", "pull-model",
+            "Pull consumption model."),
+    PUSHMODEL("push-model", "push-model",
+            "Push consumption model."),
+    FETCHTHREADS("num-fetch-threads", "num-fetch-threads",
+            "Integer: count",
+            "Number of fetch threads, default: num of cpu count."),
+    FROMLATEST("from-latest", "from-latest",
+            "Start to consume from the latest message present in the log."),
+    FROMBEGINNING("from-beginning", "from-beginning",
+            "If the consumer does not already have an established offset to consume from,"
+                    + " start with the earliest message present in the log rather than the latest message."),
+    OUTPUTINTERVAL("output-interval", "output-interval",
+            "Integer: interval_ms",
+            "Interval in milliseconds at which to print progress info. (default: 5000)");
+
+
+    CliArgDef(String opt, String longOpt, String optDesc) {
+        this(opt, longOpt, false, "", optDesc);
+    }
+
+    CliArgDef(String opt, String longOpt, String argDesc, String optDesc) {
+        this(opt, longOpt, true, argDesc, optDesc);
+    }
+
+    CliArgDef(String opt, String longOpt, boolean hasArg, String argDesc, String optDesc) {
+        this.opt = opt;
+        this.longOpt = longOpt;
+        this.hasArg = hasArg;
+        this.argDesc = argDesc;
+        this.optDesc = optDesc;
+    }
+
+    public final String opt;
+    public final String longOpt;
+    public final boolean hasArg;
+    public final String argDesc;
+    public final String optDesc;
+}

tubemq-server/src/main/java/org/apache/tubemq/server/common/webbase/WebFieldDef.java → tubemq-server/src/main/java/org/apache/tubemq/server/common/fielddef/WebFieldDef.java

@@ -15,21 +15,25 @@
  * limitations under the License.
  */
 
-package org.apache.tubemq.server.common.webbase;
+package org.apache.tubemq.server.common.fielddef;
 
 import org.apache.tubemq.corebase.TBaseConstants;
 import org.apache.tubemq.corebase.TokenConstants;
 import org.apache.tubemq.corebase.utils.RegexDef;
 import org.apache.tubemq.server.common.TServerConstants;
-
+import org.apache.tubemq.server.common.webbase.WebFieldType;
 
 
 public enum WebFieldDef {
 
+    // Note: Due to compatibility considerations,
+    //      the defined fields in the scheme are forbidden to be modified,
+    //      only new fields can be added
+
     TOPICNAME(0, "topicName", "topic", WebFieldType.STRING,
             "Topic name", TBaseConstants.META_MAX_TOPICNAME_LENGTH,
             RegexDef.TMP_STRING),
-    GROUPNAME(1, "groupName", "grp", WebFieldType.STRING,
+    GROUPNAME(1, "groupName", "group", WebFieldType.STRING,
             "Group name", TBaseConstants.META_MAX_GROUPNAME_LENGTH,
             RegexDef.TMP_GROUP),
     PARTITIONID(2, "partitionId", "pid", WebFieldType.INT,
@@ -40,18 +44,18 @@ public enum WebFieldDef {
     MODIFYUSER(4, "modifyUser", "mur", WebFieldType.STRING,
             "Record modifier", TBaseConstants.META_MAX_USERNAME_LENGTH,
             RegexDef.TMP_STRING),
-    MANUALOFFSET(5, "manualOffset", "ofs", WebFieldType.LONG,
+    MANUALOFFSET(5, "manualOffset", "offset", WebFieldType.LONG,
             "Reset offset value", RegexDef.TMP_NUMBER),
     MSGCOUNT(6, "msgCount", "cnt", WebFieldType.INT,
             "Number of returned messages", RegexDef.TMP_NUMBER),
-    FILTERCONDS(7, "filterConds", "fls", WebFieldType.COMPSTRING,
+    FILTERCONDS(7, "filterConds", "flts", WebFieldType.COMPSTRING,
             "Filter condition items", TBaseConstants.CFG_FLT_MAX_FILTER_ITEM_LENGTH,
             TBaseConstants.CFG_FLT_MAX_FILTER_ITEM_COUNT, RegexDef.TMP_FILTER),
     REQUIREREALOFFSET(8, "requireRealOffset", "dko", WebFieldType.BOOLEAN,
             "Require return disk offset details"),
     NEEDREFRESH(9, "needRefresh", "nrf", WebFieldType.BOOLEAN,
             "Require refresh data"),
-    COMPSGROUPNAME(10, "groupName", "grp", WebFieldType.COMPSTRING,
+    COMPSGROUPNAME(10, "groupName", "group", WebFieldType.COMPSTRING,
             "Group name", TBaseConstants.META_MAX_GROUPNAME_LENGTH,
                    RegexDef.TMP_GROUP),
     COMPSTOPICNAME(11, "topicName", "topic", WebFieldType.COMPSTRING,

tubemq-server/src/main/java/org/apache/tubemq/server/common/utils/WebParameterUtils.java

@@ -37,7 +37,7 @@
 import org.apache.tubemq.server.broker.utils.DataStoreUtils;
 import org.apache.tubemq.server.common.TServerConstants;
 import org.apache.tubemq.server.common.TStatusConstants;
-import org.apache.tubemq.server.common.webbase.WebFieldDef;
+import org.apache.tubemq.server.common.fielddef.WebFieldDef;
 import org.apache.tubemq.server.master.TMaster;
 import org.apache.tubemq.server.master.bdbstore.bdbentitys.BdbBrokerConfEntity;
 import org.apache.tubemq.server.master.nodemanage.nodebroker.BrokerConfManager;