geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jdil...@apache.org
Subject svn commit: r572173 - /geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java
Date Sun, 02 Sep 2007 21:58:08 GMT
Author: jdillon
Date: Sun Sep  2 14:58:07 2007
New Revision: 572173

URL: http://svn.apache.org/viewvc?rev=572173&view=rev
Log:
Re-implemented the InteractiveConsole as ShellRunner

Added:
    geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java
  (with props)

Added: geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java
URL: http://svn.apache.org/viewvc/geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java?rev=572173&view=auto
==============================================================================
--- geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java
(added)
+++ geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java
Sun Sep  2 14:58:07 2007
@@ -0,0 +1,248 @@
+/*
+ * 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
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.geronimo.gshell;
+
+import java.io.IOException;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Support for running a {@link Shell}.
+ *
+ * @version $Rev$ $Date$
+ */
+public abstract class ShellRunner
+    implements Runnable
+{
+    protected final Logger log = LoggerFactory.getLogger(getClass());
+
+    protected final Shell shell;
+
+    protected boolean running = false;
+
+    protected boolean breakOnNull = true;
+
+    protected boolean autoTrim = true;
+
+    protected boolean ignoreEmpty = true;
+
+    protected Prompter prompter = new Prompter() {
+        public String prompt() {
+            return "> ";
+        }
+    };
+
+    protected Executor executor = new Executor() {
+        public Result execute(final Shell shell, final String line) throws Exception {
+            Object result = shell.execute(line);
+
+            log.debug("Result: {}", result);
+
+            return Result.CONTINUE;
+        }
+    };
+    
+    protected ErrorHandler errorHandler = new ErrorHandler() {
+        public Result handleError(Throwable error) {
+            return Result.STOP;
+        }
+    };
+
+    public ShellRunner(final Shell shell) {
+        assert shell != null;
+
+        this.shell = shell;
+    }
+
+    public boolean isRunning() {
+        return running;
+    }
+
+    public void setRunning(final boolean running) {
+        this.running = running;
+    }
+
+    public boolean isBreakOnNull() {
+        return breakOnNull;
+    }
+
+    public void setBreakOnNull(final boolean breakOnNull) {
+        this.breakOnNull = breakOnNull;
+    }
+
+    public boolean isAutoTrim() {
+        return autoTrim;
+    }
+
+    public void setAutoTrim(final boolean autoTrim) {
+        this.autoTrim = autoTrim;
+    }
+
+    public boolean isIgnoreEmpty() {
+        return ignoreEmpty;
+    }
+
+    public void setIgnoreEmpty(final boolean ignoreEmpty) {
+        this.ignoreEmpty = ignoreEmpty;
+    }
+
+    public ErrorHandler getErrorHandler() {
+        return errorHandler;
+    }
+
+    public void setErrorHandler(final ErrorHandler errorHandler) {
+        this.errorHandler = errorHandler;
+    }
+
+    public Prompter getPrompter() {
+        return prompter;
+    }
+
+    public void setPrompter(final Prompter prompter) {
+        this.prompter = prompter;
+    }
+
+    public Executor getExecutor() {
+        return executor;
+    }
+
+    public void setExecutor(final Executor executor) {
+        this.executor = executor;
+    }
+
+    public void run() {
+        log.debug("Running");
+
+        running = true;
+
+        while (running) {
+            try {
+                running = work();
+            }
+            catch (ExitNotification n) {
+                throw n;
+            }
+            catch (Throwable t) {
+                log.debug("Work failed: {}", t);
+                
+                if (errorHandler != null) {
+                    ErrorHandler.Result result = errorHandler.handleError(t);
+
+                    // Allow the error handler to request that the loop stop
+                    if (result == ErrorHandler.Result.STOP) {
+                        log.debug("Error handler requested STOP");
+                        running = false;
+                    }
+                }
+            }
+        }
+
+        log.debug("Finished");
+    }
+
+    protected boolean work() throws Exception {
+        String line = readLine(prompter.prompt());
+
+        log.debug("Read line: {}", line);
+
+        // Log the line as HEX if trace is enabled
+        if (log.isTraceEnabled()) {
+            StringBuffer idx = new StringBuffer();
+            StringBuffer hex = new StringBuffer();
+
+            byte[] bytes = line.getBytes();
+            for (byte b : bytes) {
+                String h = Integer.toHexString(b);
+
+                hex.append("x").append(h).append(" ");
+                idx.append(" ").append((char)b).append("  ");
+            }
+
+            log.trace("HEX: {}", hex);
+            log.trace("     {}", idx);
+        }
+
+        // Stop on null (maybe, else ignore)
+        if (line == null) {
+            return !breakOnNull;
+        }
+
+        // Auto trim the line (maybe)
+        if (autoTrim) {
+            line = line.trim();
+        }
+
+        // Ingore empty lines (maybe)
+        if (ignoreEmpty && line.length() == 0) {
+            return true;
+        }
+
+        // Execute the line
+        Executor.Result result = executor.execute(shell, line);
+
+        // Allow executor to request that the loop stop
+        if (result == Executor.Result.STOP) {
+            log.debug("Executor requested STOP");
+            return false;
+        }
+
+        return true;
+    }
+
+    protected abstract String readLine(String prompt) throws IOException;
+
+    //
+    // Prompter
+    //
+
+    public static interface Prompter
+    {
+        String prompt();
+    }
+
+    //
+    // Executor
+    //
+
+    public static interface Executor
+    {
+        enum Result {
+            CONTINUE,
+            STOP
+        }
+
+        Result execute(Shell shell, String line) throws Exception;
+    }
+
+    //
+    // ErrorHandler
+    //
+
+    public static interface ErrorHandler
+    {
+        enum Result {
+            CONTINUE,
+            STOP
+        }
+        
+        Result handleError(Throwable error);
+    }
+}

Propchange: geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/ShellRunner.java
------------------------------------------------------------------------------
    svn:mime-type = text/plain



Mime
View raw message