#569: Reworked the options name for war and warLocation. Polished the…

… usage. Make sure warLocation take precedence over war, so you can override it.
hawtio · Oct 28, 2013 · 3346b02 · 3346b02
1 parent 94dbec8
commit 3346b02
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 30 deletions.
diff --git a/doc/GetStarted.md b/doc/GetStarted.md
@@ -17,7 +17,11 @@ And the console should show you which URL to open to view hawtio; which by defau
 
 You can specify the port number to use, for example to use port 8090 run from the command line:
 
-    java -jar hawtio-app-1.2-M25.jar 8090
+    java -jar hawtio-app-1.2-M25.jar --port 8090
+
+hawtio supports other options which you can get listed by running from command line:
+
+    java -jar hawtio-app-1.2-M25.jar --help
 
 ## Using a Servlet Engine or Application Server
 

diff --git a/hawtio-app/src/main/java/io/hawt/app/App.java b/hawtio-app/src/main/java/io/hawt/app/App.java
@@ -68,7 +68,7 @@ public static void main(String[] args) {
             writeStreamTo(resource.openStream(), new FileOutputStream(warFile), 64 * KB);
 
             String warPath = warFile.getCanonicalPath();
-            main.setWarLocation(warPath);
+            main.setWar(warPath);
         } catch (Exception e) {
             System.out.println("Failed to create hawtio: " + e.getMessage());
             e.printStackTrace();

diff --git a/hawtio-embedded/src/main/java/io/hawt/embedded/Main.java b/hawtio-embedded/src/main/java/io/hawt/embedded/Main.java
@@ -80,10 +80,10 @@ public void run(boolean join) throws Exception {
 
         String war = findWar(options.getWarLocation());
         if (war == null) {
-            war = findWar(options.getWarFileName());
+            war = options.getWar();
         }
         if (war == null) {
-            throw new IllegalArgumentException("No war property set!");
+            throw new IllegalArgumentException("No war or warLocation options set!");
         }
         webapp.setWar(war);
         webapp.setParentLoaderPriority(true);
@@ -155,14 +155,6 @@ protected boolean isWarFileName(String name) {
         return name.toLowerCase().endsWith(".war");
     }
 
-    public String getWarFileName() {
-        return options.getWarFileName();
-    }
-
-    public void setWarFileName(String warFileName) {
-        options.setWarFileName(warFileName);
-    }
-
     public String getWarLocation() {
         return options.getWarLocation();
     }
@@ -171,6 +163,14 @@ public void setWarLocation(String warLocation) {
         options.setWarLocation(warLocation);
     }
 
+    public String getWar() {
+        return options.getWar();
+    }
+
+    public void setWar(String war) {
+        options.setWar(war);
+    }
+
     public String getContextPath() {
         return options.getContextPath();
     }

diff --git a/hawtio-embedded/src/main/java/io/hawt/embedded/Options.java b/hawtio-embedded/src/main/java/io/hawt/embedded/Options.java
@@ -25,8 +25,8 @@
 public class Options {
 
     private final List<Option> options = new ArrayList<Option>();
-    private String warFileName;
     private String warLocation;
+    private String war;
     private String contextPath = "/hawtio";
     private Integer port = 8080;
     private String extraClassPath;
@@ -71,11 +71,9 @@ public String getInformation() {
     }
 
     private abstract class ParameterOption extends Option {
-        private String parameterName;
 
-        protected ParameterOption(String abbreviation, String fullName, String description, String parameterName) {
+        protected ParameterOption(String abbreviation, String fullName, String description) {
             super(abbreviation, fullName, description);
-            this.parameterName = parameterName;
         }
 
         protected void doProcess(String arg, LinkedList<String> remainingArgs) {
@@ -89,8 +87,7 @@ protected void doProcess(String arg, LinkedList<String> remainingArgs) {
         }
 
         public String getInformation() {
-            return "  " + getAbbreviation() + " or " + getFullName()
-                    + " <" + parameterName + "> = " + getDescription();
+            return "  " + getAbbreviation() + " or " + getFullName() + " = " + getDescription();
         }
 
         protected abstract void doProcess(String arg, String parameter, LinkedList<String> remainingArgs);
@@ -103,19 +100,19 @@ protected void doProcess(String arg, LinkedList<String> remainingArgs) {
             }
         });
 
-        addOption(new ParameterOption("f", "warFileName", "Filename of the WAR file", "file") {
+        addOption(new ParameterOption("w", "war", "War file or directory of the hawtio web application") {
             protected void doProcess(String arg, String parameter, LinkedList<String> remainingArgs) {
-                warFileName = parameter;
+                war = parameter;
             }
         });
 
-        addOption(new ParameterOption("l", "warLocation", "Directory of the location of the exploded WAR application", "location") {
+        addOption(new ParameterOption("l", "warLocation", "Director to search for .war files") {
             protected void doProcess(String arg, String parameter, LinkedList<String> remainingArgs) {
                 warLocation = parameter;
             }
         });
 
-        addOption(new ParameterOption("c", "contextPath", "Context path", "contextPath") {
+        addOption(new ParameterOption("c", "contextPath", "Context path") {
             protected void doProcess(String arg, String parameter, LinkedList<String> remainingArgs) {
                 // must have leading slash
                 if (!parameter.startsWith("/")) {
@@ -126,7 +123,7 @@ protected void doProcess(String arg, String parameter, LinkedList<String> remain
             }
         });
 
-        addOption(new ParameterOption("p", "port", "Port number", "port") {
+        addOption(new ParameterOption("p", "port", "Port number") {
             protected void doProcess(String arg, String parameter, LinkedList<String> remainingArgs) {
                 try {
                     port = Integer.parseInt(parameter);
@@ -136,7 +133,7 @@ protected void doProcess(String arg, String parameter, LinkedList<String> remain
             }
         });
 
-        addOption(new ParameterOption("ecp", "extraClassPath", "Extra classpath", "ecp") {
+        addOption(new ParameterOption("ecp", "extraClassPath", "Extra classpath") {
             protected void doProcess(String arg, String parameter, LinkedList<String> remainingArgs) {
                 extraClassPath = parameter;
             }
@@ -161,8 +158,8 @@ public void showOptions() {
     public String usedOptionsSummary() {
         StringBuilder sb = new StringBuilder();
         sb.append("Using options [");
-        if (warFileName != null) {
-            sb.append("\n\twarFileName=").append(warFileName);
+        if (war != null) {
+            sb.append("\n\twar=").append(war);
         }
         if (warLocation != null) {
             sb.append("\n\twarLocation=").append(warLocation);
@@ -205,12 +202,12 @@ public boolean parseArguments(String[] arguments) {
         return valid;
     }
 
-    public String getWarFileName() {
-        return warFileName;
+    public String getWar() {
+        return war;
     }
 
-    public void setWarFileName(String warFileName) {
-        this.warFileName = warFileName;
+    public void setWar(String war) {
+        this.war = war;
     }
 
     public String getWarLocation() {