aeshell · stalep · Jun 9, 2016 · Jun 9, 2016
diff --git a/src/main/java/AeshExample.java b/src/main/java/AeshExample.java
@@ -72,6 +72,7 @@
 import java.io.InputStreamReader;
 import java.util.ArrayList;
 import java.util.List;
+import org.jboss.aesh.console.command.CommandException;
 
 /**
  * @author <a href="mailto:stale.pedersen@jboss.org">Ståle W. Pedersen</a>
@@ -170,7 +171,7 @@ public void handleInterrupt(Console console) {
     public static class ExitCommand implements Command {
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             commandInvocation.stop();
             return CommandResult.SUCCESS;
         }
@@ -183,15 +184,19 @@ public static class RunCommand implements Command {
         private List<Resource> arguments;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
 
             commandInvocation.putProcessInBackground();
 
-            if(arguments != null && arguments.size() > 0 && arguments.get(0).isLeaf()) {
-                List<String> script = readScriptFile(arguments.get(0));
+            if (arguments != null && arguments.size() > 0 && arguments.get(0).isLeaf()) {
+                try {
+                    List<String> script = readScriptFile(arguments.get(0));
 
-                for (String line : script) {
-                    commandInvocation.executeCommand(line + Config.getLineSeparator());
+                    for (String line : script) {
+                        commandInvocation.executeCommand(line + Config.getLineSeparator());
+                    }
+                } catch (IOException ex) {
+                    throw new CommandException(ex);
                 }
             }
 
@@ -221,7 +226,7 @@ public static class FooCommand implements Command {
         private String foo;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
            if(bar == null)
                commandInvocation.getShell().out().println("NO BAR!");
             else {
@@ -251,14 +256,18 @@ public static class TestConsoleCommand implements Command {
         private Shell shell;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             this.shell = commandInvocation.getShell();
             if(help) {
                 shell.out().println(commandInvocation.getHelpInfo("test"));
             }
             else {
-                //display();
-                processOperation(commandInvocation);
+                try {
+                    //display();
+                    processOperation(commandInvocation);
+                } catch (IOException ex) {
+                    throw new CommandException(ex);
+                }
             }
 
             return CommandResult.SUCCESS;
@@ -335,7 +344,7 @@ public static class LsCommand implements Command {
         private List<Resource> arguments;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             if(help) {
                 commandInvocation.getShell().out().println(commandInvocation.getHelpInfo("ls"));
             }
@@ -385,7 +394,7 @@ public static class PromptCommand implements Command {
         private Shell shell;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             this.shell = commandInvocation.getShell();
             if(bar) {
                 shell.out().print("are you sure you want bar? (y/n) ");
@@ -401,7 +410,7 @@ public CommandResult execute(CommandInvocation commandInvocation) throws IOExcep
             return CommandResult.SUCCESS;
         }
 
-        public void processOperation(CommandOperation operation) throws IOException {
+        public void processOperation(CommandOperation operation) {
             if(operation.getInputKey() == Key.y) {
                 shell.out().println(Config.getLineSeparator()+"you wanted bar!");
             }
@@ -524,7 +533,7 @@ public static class GroupCommand implements Command {
         private boolean help;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             if(help)
                 commandInvocation.getShell().out().println(commandInvocation.getHelpInfo("group"));
             else
@@ -542,7 +551,7 @@ public static class Child1 implements Command {
         private boolean help;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             if(help)
                 commandInvocation.getShell().out().println(commandInvocation.getHelpInfo("group child1"));
             else
@@ -557,7 +566,7 @@ public static class Child2 implements Command {
         private boolean bar;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             commandInvocation.getShell().out().println("bar is set to: "+bar);
             return CommandResult.SUCCESS;
         }

diff --git a/src/main/java/AeshGraphicsExample.java b/src/main/java/AeshGraphicsExample.java
@@ -36,7 +36,7 @@
 import org.jboss.aesh.terminal.Key;
 import org.jboss.aesh.terminal.TerminalColor;
 
-import java.io.IOException;
+import org.jboss.aesh.console.command.CommandException;
 
 /**
  * @author <a href="mailto:stale.pedersen@jboss.org">Ståle W. Pedersen</a>
@@ -65,7 +65,7 @@ public static void main(String[] args) {
     public static class ExitCommand implements Command {
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             commandInvocation.stop();
             return CommandResult.SUCCESS;
         }
@@ -78,7 +78,7 @@ public static class GraphicsCommand implements Command {
         private Graphics g;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             invocation = commandInvocation;
             invocation.getShell().enableAlternateBuffer();
             doGfx();

diff --git a/src/main/java/org/jboss/aesh/cl/result/NullResultHandler.java b/src/main/java/org/jboss/aesh/cl/result/NullResultHandler.java
@@ -19,6 +19,7 @@
  */
 package org.jboss.aesh.cl.result;
 
+import org.jboss.aesh.console.command.CommandException;
 import org.jboss.aesh.console.command.CommandResult;
 
 /**
@@ -37,4 +38,8 @@ public void onFailure(CommandResult result) {
     @Override
     public void onValidationFailure(CommandResult result, Exception exception) {
     }
+
+    @Override
+    public void onExecutionFailure(CommandResult result, CommandException exception) {
+    }
 }
diff --git a/src/main/java/org/jboss/aesh/cl/result/ResultHandler.java b/src/main/java/org/jboss/aesh/cl/result/ResultHandler.java
@@ -19,6 +19,7 @@
  */
 package org.jboss.aesh.cl.result;
 
+import org.jboss.aesh.console.command.CommandException;
 import org.jboss.aesh.console.command.CommandResult;
 
 /**
@@ -31,4 +32,6 @@ public interface ResultHandler {
     void onFailure(CommandResult result);
 
     void onValidationFailure(CommandResult result, Exception exception);
+
+    void onExecutionFailure(CommandResult result, CommandException exception);
 }
diff --git a/src/main/java/org/jboss/aesh/console/AeshConsoleImpl.java b/src/main/java/org/jboss/aesh/console/AeshConsoleImpl.java
@@ -32,6 +32,7 @@
 import org.jboss.aesh.cl.validator.OptionValidatorException;
 import org.jboss.aesh.complete.CompleteOperation;
 import org.jboss.aesh.complete.Completion;
+import org.jboss.aesh.console.command.CommandException;
 import org.jboss.aesh.console.command.CommandNotFoundException;
 import org.jboss.aesh.console.command.CommandResult;
 import org.jboss.aesh.console.command.activator.AeshOptionActivatorProvider;
@@ -352,8 +353,13 @@ else if(resultHandler != null)
                     result = CommandResult.FAILURE;
                     if(commandNotFoundHandler != null)
                         commandNotFoundHandler.handleCommandNotFound(output.getBuffer(), getShell());
-                }
-                catch (Exception e) {
+                } catch (CommandException cmd) {
+                    getShell().out().println(cmd.getMessage());
+                    result = CommandResult.FAILURE;
+                    if (resultHandler != null) {
+                        resultHandler.onExecutionFailure(result, cmd);
+                    }
+                } catch (Exception e) {
                     if(e instanceof InterruptedException)
                         throw (InterruptedException) e;
                     else {

diff --git a/src/main/java/org/jboss/aesh/console/command/Command.java b/src/main/java/org/jboss/aesh/console/command/Command.java
@@ -33,8 +33,9 @@ public interface Command<T extends CommandInvocation> {
      *
      * @param commandInvocation invocation
      * @return success or failure depending on how the execution went.
-     * @throws IOException
-     * @throws InterruptedException
+     * @throws CommandException In case an exception occurs during execution
+     * @throws InterruptedException In case the current thread is being
+     * interrupted.
      */
-    CommandResult execute(T commandInvocation) throws IOException, InterruptedException;
+    CommandResult execute(T commandInvocation) throws CommandException, InterruptedException;
 }
diff --git a/src/main/java/org/jboss/aesh/console/command/CommandException.java b/src/main/java/org/jboss/aesh/console/command/CommandException.java
@@ -0,0 +1,34 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package org.jboss.aesh.console.command;
+
+/**
+ *
+ * An exception thrown by Commands when exception occurs
+ *
+ * @author jdenise@redhat.com
+ */
+public final class CommandException extends Exception {
+
+    private static final long serialVersionUID = -1098155769714455108L;
+
+    public CommandException() {
+        super();
+    }
+
+    public CommandException(String message) {
+        super(message);
+    }
+
+    public CommandException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public CommandException(Throwable cause) {
+        super(cause);
+    }
+
+}
diff --git a/src/main/java/org/jboss/aesh/console/command/container/CommandContainer.java b/src/main/java/org/jboss/aesh/console/command/container/CommandContainer.java
@@ -30,6 +30,7 @@
 import org.jboss.aesh.parser.AeshLine;
 
 import java.io.IOException;
+import org.jboss.aesh.console.command.CommandException;
 
 /**
  * A CommandContainer hold reference to the Command and
@@ -65,5 +66,7 @@ public interface CommandContainer<T extends Command> extends AutoCloseable {
 
     CommandContainerResult executeCommand(AeshLine line, InvocationProviders invocationProviders,
                                           AeshContext aeshContext,
-                                          CommandInvocation commandInvocation) throws CommandLineParserException, OptionValidatorException, CommandValidatorException, IOException, InterruptedException;
+            CommandInvocation commandInvocation)
+            throws CommandLineParserException, OptionValidatorException,
+            CommandValidatorException, CommandException, InterruptedException;
 }
diff --git a/src/main/java/org/jboss/aesh/console/command/container/DefaultCommandContainer.java b/src/main/java/org/jboss/aesh/console/command/container/DefaultCommandContainer.java
@@ -32,6 +32,7 @@
 import org.jboss.aesh.parser.AeshLine;
 
 import java.io.IOException;
+import org.jboss.aesh.console.command.CommandException;
 
 /**
  * @author <a href="mailto:stale.pedersen@jboss.org">Ståle W. Pedersen</a>
@@ -42,7 +43,7 @@ public abstract class DefaultCommandContainer<C extends Command> implements Comm
     public CommandContainerResult executeCommand(AeshLine line, InvocationProviders invocationProviders,
                                                  AeshContext aeshContext,
                                                  CommandInvocation commandInvocation)
-            throws CommandLineParserException, OptionValidatorException, CommandValidatorException, IOException, InterruptedException {
+            throws CommandLineParserException, OptionValidatorException, CommandValidatorException, CommandException, InterruptedException {
 
         CommandLine commandLine = getParser().parse(line, false);
         commandLine.getParser().getCommandPopulator().populateObject(commandLine, invocationProviders, aeshContext, true);

diff --git a/src/main/java/org/jboss/aesh/console/man/Man.java b/src/main/java/org/jboss/aesh/console/man/Man.java
@@ -34,6 +34,7 @@
 import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.List;
+import org.jboss.aesh.console.command.CommandException;
 
 /**
  * A Man implementation for Aesh. ref: http://en.wikipedia.org/wiki/Man_page
@@ -86,7 +87,7 @@ else if(getSearchStatus() == TerminalPage.Search.NO_SEARCH ||
     }
 
     @Override
-    public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+    public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
         if(manPages == null || manPages.size() == 0) {
             commandInvocation.getShell().out().println("What manual page do you want?");
             return CommandResult.SUCCESS;
@@ -100,8 +101,12 @@ public CommandResult execute(CommandInvocation commandInvocation) throws IOExcep
         InputStream inputStream = manProvider.getManualDocument(manPages.get(0));
         if(inputStream != null) {
             setCommandInvocation(commandInvocation);
-            fileParser.setInput(inputStream);
-            afterAttach();
+            try {
+                fileParser.setInput(inputStream);
+                afterAttach();
+            } catch (IOException ex) {
+                throw new CommandException(ex);
+            }
         }
 
         return CommandResult.SUCCESS;

diff --git a/src/test/java/org/jboss/aesh/cl/CommandLineParserTest.java b/src/test/java/org/jboss/aesh/cl/CommandLineParserTest.java
@@ -27,9 +27,9 @@
 import org.jboss.aesh.console.command.invocation.CommandInvocation;
 import org.junit.Test;
 
-import java.io.IOException;
 import java.util.List;
 import java.util.Map;
+import org.jboss.aesh.console.command.CommandException;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
@@ -355,7 +355,7 @@ public class GroupCommandTest extends TestingCommand {
 
     public class TestingCommand implements Command {
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             return CommandResult.SUCCESS;
         }
     }
@@ -374,7 +374,7 @@ public class SubHelp extends HelpClass implements Command {
         private String foo;
 
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             return CommandResult.SUCCESS;
         }
     }

diff --git a/src/test/java/org/jboss/aesh/cl/ParseCompleteObjectTest.java b/src/test/java/org/jboss/aesh/cl/ParseCompleteObjectTest.java
@@ -28,8 +28,8 @@
 import org.jboss.aesh.console.command.invocation.CommandInvocation;
 import org.junit.Test;
 
-import java.io.IOException;
 import java.util.List;
+import org.jboss.aesh.console.command.CommandException;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
@@ -357,7 +357,7 @@ public class ParseCompleteGroupChild2 extends TestCommand {
 
     public class TestCommand implements Command {
         @Override
-        public CommandResult execute(CommandInvocation commandInvocation) throws IOException, InterruptedException {
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
             return CommandResult.SUCCESS;
         }
     }