();
+ }
+
+ /**
+ *
+ * Register a new observer.
+ *
+ *
+ * @deprecated use registerXYZListener instead
+ * @param observer
+ * observer to be added
+ */
+ public void registerObserver(ConsoleObserver observer) {
+ registerOutputListener(observer);
+ registerErrorListener(observer);
+ registerTraceListener(observer);
+ registerCommandListener(observer);
+ registerExceptionListener(observer);
+ }
+
+ /**
+ *
+ * Registers an output listener.
+ *
+ *
+ * @param listener
+ * listener that is registered
+ */
+ public void registerOutputListener(IOutputListener listener) {
+ outputListener.add(listener);
+ }
+
+ /**
+ *
+ * Registers an error listener.
+ *
+ *
+ * @param listener
+ * listener that is registered
+ */
+ public void registerErrorListener(IErrorListener listener) {
+ errorListener.add(listener);
+ }
+
+ /**
+ *
+ * Registers a trace listener.
+ *
+ *
+ * @param listener
+ * listener that is registered
+ */
+ public void registerTraceListener(ITraceListener listener) {
+ traceListener.add(listener);
+ }
+
+ /**
+ *
+ * Registers a command listener.
+ *
+ *
+ * @param listener
+ * listener that is registered
+ */
+ public void registerCommandListener(ICommandListener listener) {
+ commandListener.add(listener);
+ }
+
+ /**
+ *
+ * Registers an exception listener.
+ *
+ *
+ * @param listener
+ * listener that is registered
+ */
+ public void registerExceptionListener(IExceptionListener listener) {
+ exceptionListener.add(listener);
+ }
+
+ /**
+ *
+ * Remove an observer. If the observer is not found, nothing is done.
+ *
+ *
+ * @deprecated use removeXYZListener instead
+ * @param observer
+ * observer to be removed
+ */
+ public void deleteObserver(ConsoleObserver observer) {
+ removeOutputListener(observer);
+ removeErrorListener(observer);
+ removeTraceListener(observer);
+ removeCommandListener(observer);
+ removeExceptionListener(observer);
+ }
+
+ /**
+ *
+ * Removes an output listener.
+ *
+ *
+ * @param listener
+ * listener that is removed
+ */
+ public void removeOutputListener(IOutputListener listener) {
+ outputListener.remove(listener);
+ }
+
+ /**
+ *
+ * Removes an error listener.
+ *
+ *
+ * @param listener
+ * listener that is removed
+ */
+ public void removeErrorListener(IErrorListener listener) {
+ errorListener.remove(listener);
+ }
+
+ /**
+ *
+ * Removes an trace listener.
+ *
+ *
+ * @param listener
+ * listener that is removed
+ */
+ public void removeTraceListener(ITraceListener listener) {
+ traceListener.remove(listener);
+ }
+
+ /**
+ *
+ * Removes a command listener.
+ *
+ *
+ * @param listener
+ * listener that is removed
+ */
+ public void removeCommandListener(ICommandListener listener) {
+ commandListener.remove(listener);
+ }
+
+ /**
+ *
+ * Removes an exception listener.
+ *
+ *
+ * @param listener
+ * listener that is removed
+ */
+ public void removeExceptionListener(IExceptionListener listener) {
+ exceptionListener.remove(listener);
+ }
+
+ /**
+ *
+ * Checks if a listener is registered.
+ *
+ *
+ * @param listener
+ * listener that is checked
+ * @return true, is listener is registered; false, otherwise
+ */
+ public boolean hasOutputListener(IOutputListener listener) {
+ return outputListener.contains(listener);
+ }
+
+ /**
+ *
+ * Checks if a listener is registered.
+ *
+ *
+ * @param listener
+ * listener that is checked
+ * @return true, is listener is registered; false, otherwise
+ */
+ public boolean hasErrorListener(IErrorListener listener) {
+ return errorListener.contains(listener);
+ }
+
+ /**
+ *
+ * Checks if a listener is registered.
+ *
+ *
+ * @param listener
+ * listener that is checked
+ * @return true, is listener is registered; false, otherwise
+ */
+ public boolean hasTraceListener(ITraceListener listener) {
+ return traceListener.contains(listener);
+ }
+
+ /**
+ *
+ * Checks if a listener is registered.
+ *
+ *
+ * @param listener
+ * listener that is checked
+ * @return true, is listener is registered; false, otherwise
+ */
+ public boolean hasCommandListener(ICommandListener listener) {
+ return commandListener.contains(listener);
+ }
+
+ /**
+ *
+ * Checks if a listener is registered.
+ *
+ *
+ * @param listener
+ * listener that is checked
+ * @return true, is listener is registered; false, otherwise
+ */
+ public boolean hasExceptionListener(IExceptionListener listener) {
+ return exceptionListener.contains(listener);
+ }
+
+ /**
+ *
+ * Sends a message to all observers containing the message that was passed
+ * to this function.
+ *
+ *
+ * @param msg
+ * message that is send to the console
+ */
+ public static void print(String msg) {
+ for (IOutputListener observer : theInstance.outputListener) {
+ observer.outputMsg(msg);
+ }
+ }
+
+ /**
+ *
+ * Sends a message to all observers containing the message that was passed
+ * to this function and adds an endline to the message.
+ *
+ *
+ * @param msg
+ * message that is send to the observers
+ */
+ public static void println(String msg) {
+ for (IOutputListener observer : theInstance.outputListener) {
+ observer.outputMsg(msg + StringTools.ENDLINE);
+ }
+ }
+
+ /**
+ *
+ * Sends an error message to all observers containing the message that was
+ * passed to this function.
+ *
+ *
+ * @param errMsg
+ * message that is send to the observers
+ */
+ public static void printerr(String errMsg) {
+ for (IErrorListener observer : theInstance.errorListener) {
+ observer.errorMsg(errMsg);
+ }
+ }
+
+ /**
+ *
+ * Sends an error message to all observers containing the message that was
+ * passed to this function and adds an endline to the message.
+ *
+ *
+ * @param errMsg
+ * message that is send to the observers
+ */
+ public static void printerrln(String errMsg) {
+ for (IErrorListener observer : theInstance.errorListener) {
+ observer.errorMsg(errMsg + StringTools.ENDLINE);
+ }
+ }
+
+ /**
+ *
+ * Sends an exception to all observers to print its stack trace.
+ *
+ *
+ * @param e
+ * exception whose stack trace is to be printed
+ */
+ public static void logException(Exception e) {
+ for (IExceptionListener observer : theInstance.exceptionListener) {
+ observer.logException(e);
+ }
+ }
+
+ /**
+ *
+ * Sends a debug message to all observers containing the message that was
+ * passed to this function.
+ *
+ *
+ * @param traceMsg
+ * message that is send to the observers
+ */
+ public static void trace(String traceMsg) {
+ for (ITraceListener observer : theInstance.traceListener) {
+ observer.traceMsg(traceMsg);
+ }
+ }
+
+ /**
+ *
+ * Sends a debug message to all observers containing the message that was
+ * passed to this function and adds an {@link StringTools#ENDLINE} to the
+ * message.
+ *
+ *
+ * @param traceMsg
+ * message that is send to the observers
+ */
+ public static void traceln(String traceMsg) {
+ for (ITraceListener observer : theInstance.traceListener) {
+ observer.traceMsg(traceMsg + StringTools.ENDLINE);
+ }
+ }
+
+ /**
+ *
+ * Called by {@link CommandExecuter#exec(String)}.
+ *
+ *
+ * @param command
+ * command that is executed
+ */
+ static void commandNotification(String command) {
+ for (ICommandListener observer : theInstance.commandListener) {
+ observer.commandNotification(command);
+ }
+ }
+
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/ConsoleObserver.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/ConsoleObserver.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/ConsoleObserver.java (revision 478)
@@ -0,0 +1,20 @@
+package de.ugoe.cs.util.console;
+
+import de.ugoe.cs.util.console.listener.ICommandListener;
+import de.ugoe.cs.util.console.listener.IErrorListener;
+import de.ugoe.cs.util.console.listener.IExceptionListener;
+import de.ugoe.cs.util.console.listener.IOutputListener;
+import de.ugoe.cs.util.console.listener.ITraceListener;
+
+/**
+ *
+ * Observer for Console.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 2.0
+ * @deprecated Use listeners defined in the package de.ugoe.cs.console.listeners instead.
+ */
+public interface ConsoleObserver extends ITraceListener, IOutputListener, IErrorListener, ICommandListener, IExceptionListener {
+
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/FileOutputListener.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/FileOutputListener.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/FileOutputListener.java (revision 478)
@@ -0,0 +1,126 @@
+package de.ugoe.cs.util.console;
+
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
+
+import de.ugoe.cs.util.console.listener.IOutputListener;
+
+/**
+ *
+ * Implements an {@link IOutputListener} for the {@link Console} that logs all
+ * outputs in a file. This can be used to "pipe" the output-stream of the
+ * console into a file. The advantage of using this mechanism for piping is that
+ * the file will only contain the output stream. No errors, no commands, etc.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public class FileOutputListener implements IOutputListener {
+
+ /**
+ *
+ * Flag that ensures that only one log message is produced if the listener
+ * breaks, e.g., because of a full hard disk/quota.
+ *
+ */
+ boolean failureLogged = false;
+
+ /**
+ *
+ * Name of the output file.
+ *
+ */
+ String filename;
+
+ /**
+ *
+ * Writer for the output.
+ *
+ */
+ OutputStreamWriter writer = null;
+
+ /**
+ *
+ * Constructor. Creates a new FileOutputListener.
+ *
+ *
+ * @param filename
+ * name and path of the file the listener writes to.
+ */
+ public FileOutputListener(String filename) {
+ this.filename = filename;
+
+ }
+
+ /**
+ *
+ * Starts the listener by opening the file and registering it with the
+ * {@link Console}.
+ *
+ */
+ public void start() {
+ try {
+ FileOutputStream fos = new FileOutputStream(filename);
+ writer = new OutputStreamWriter(fos, "UTF-8");
+ Console.getInstance().registerOutputListener(this);
+ } catch (IOException e) {
+ Console.printerrln("Failed to start FileOutputListener for file "
+ + filename + ": " + e.getMessage());
+ }
+ }
+
+ /**
+ *
+ * Stops the listener by closing the file and removing itself from the
+ * {@link Console}.
+ *
+ */
+ public void stop() {
+ Console.getInstance().removeOutputListener(this);
+ if( writer!=null ) {
+ try {
+ writer.close();
+ writer = null;
+ } catch (IOException e) {
+ Console.printerrln("Failed to close file " + filename + ": "
+ + e.getMessage());
+ }
+ }
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * de.ugoe.cs.util.console.listener.IOutputListener#outputMsg(java.lang.
+ * String)
+ */
+ @Override
+ public void outputMsg(String newMessage) {
+ if( writer!=null ) {
+ try {
+ writer.write(newMessage);
+ } catch (IOException e) {
+ if (!failureLogged) {
+ Console.printerrln("FileOutpustListener for file " + filename
+ + " broken: " + e.getMessage());
+ failureLogged = true;
+ }
+ }
+ }
+ }
+
+ /**
+ *
+ * Returns the name of the log file used by this listener.
+ *
+ *
+ * @return name of the log file
+ */
+ public String getFilename() {
+ return filename;
+ }
+
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/TextConsole.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/TextConsole.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/TextConsole.java (revision 478)
@@ -0,0 +1,149 @@
+package de.ugoe.cs.util.console;
+
+import java.io.IOException;
+import java.nio.charset.Charset;
+
+import de.ugoe.cs.util.console.listener.IErrorListener;
+import de.ugoe.cs.util.console.listener.IExceptionListener;
+import de.ugoe.cs.util.console.listener.IOutputListener;
+import de.ugoe.cs.util.console.listener.ITraceListener;
+
+/**
+ *
+ * Implements a simple console observer that prints normal text to
+ * {@code stdout}, errors to {@code stderr} and reads from {@code stdin}.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public class TextConsole implements IOutputListener, IErrorListener,
+ ITraceListener, IExceptionListener {
+
+ /**
+ *
+ * In the debug mode, trace messages will be printed.
+ *
+ */
+ private boolean debugMode = true;
+
+ /**
+ *
+ * Creates a new text console and automatically registers it as observer.
+ *
+ */
+ public TextConsole() {
+ Console.getInstance().registerOutputListener(this);
+ Console.getInstance().registerErrorListener(this);
+ Console.getInstance().registerTraceListener(this);
+ Console.getInstance().registerExceptionListener(this);
+ }
+
+ /**
+ *
+ * Prints messages to {@code stdout}.
+ *
+ *
+ * @see ConsoleObserver#outputMsg(java.lang.String)
+ */
+ public void outputMsg(String newMessage) {
+ System.out.print(newMessage);
+ }
+
+ /**
+ *
+ * Prints messages to {@code stderr}.
+ *
+ *
+ * @see ConsoleObserver#errorMsg(String)
+ */
+ @Override
+ public void errorMsg(String errMessage) {
+ System.err.print(errMessage);
+ }
+
+ /**
+ *
+ * Prints the stacktrace of an exception to {@code stderr}.
+ *
+ *
+ * @see ConsoleObserver#logException(Exception)
+ */
+ @Override
+ public void logException(Exception e) {
+ System.err.println(e.getMessage());
+ }
+
+ /**
+ *
+ * Prints messages to {@code stdout}. These messages are only printed, if
+ * the console is run in debug mode.
+ *
+ */
+ @Override
+ public void traceMsg(String traceMessage) {
+ if (debugMode) {
+ System.out.print(traceMessage);
+ }
+ }
+
+ /**
+ *
+ * Starts a new TextConsole. If the text console is started, it can be used
+ * not only to print message, but also to execute commands by reading
+ * {@code stdin}.
+ *
+ *
+ * @param debugMode
+ * true, if the application is to run in debug mode, i.e. trace
+ * messages will be printed
+ */
+ public void run(boolean debugMode) {
+ this.debugMode = debugMode;
+ CommandExecuter exec = CommandExecuter.getInstance();
+ while (true) {
+ System.out.print("> ");
+ String command = getCommand().trim();
+ if (!command.equals("")) {
+ exec.exec(command);
+ }
+ }
+ }
+
+ /**
+ *
+ * Reads a new command from {@code stdin}.
+ *
+ *
+ * @return a string with a command
+ */
+ protected String getCommand() {
+ byte[] buffer = new byte[1024];
+ int bytesRead = 0;
+ String command;
+ try {
+ bytesRead = System.in.read(buffer);
+ } catch (IOException e) {
+
+ }
+ if (bytesRead == 0) {
+ command = "";
+ } else {
+ command = new String(buffer, Charset.defaultCharset());
+ }
+ return command;
+ }
+
+ /**
+ *
+ * Configures if the debug mode of the text console is enabled.
+ *
+ *
+ * @param debug
+ * if true, debug mode is enabled.
+ */
+ public void setDebug(boolean debug) {
+ debugMode = debug;
+ }
+
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDexec.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDexec.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDexec.java (revision 478)
@@ -0,0 +1,67 @@
+package de.ugoe.cs.util.console.defaultcommands;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.security.InvalidParameterException;
+import java.util.List;
+
+import de.ugoe.cs.util.console.Command;
+import de.ugoe.cs.util.console.CommandExecuter;
+import de.ugoe.cs.util.console.Console;
+
+/**
+ *
+ * Command to execute a batch of {@link Command}s. The batch is defined as a
+ * text file, where each line defines one command.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public class CMDexec implements Command {
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see de.ugoe.cs.util.console.Command#run(java.util.List)
+ */
+ public void run(List parameters) {
+ String script;
+ try {
+ script = (String) parameters.get(0);
+ } catch (Exception e) {
+ throw new InvalidParameterException();
+ }
+ try {
+ String[] commands;
+ File f = new File(script);
+ FileInputStream fis = new FileInputStream(f);
+ InputStreamReader reader = new InputStreamReader(fis, "UTF-8");
+ char[] buffer = new char[(int) f.length()];
+ reader.read(buffer);
+ commands = (new String(buffer)).split("\n");
+ for (String command : commands) {
+ Console.traceln(command.trim());
+ CommandExecuter.getInstance().exec(command);
+ }
+ reader.close();
+ } catch (FileNotFoundException e) {
+ Console.printerrln(e.getMessage());
+ } catch (IOException e) {
+ Console.printerrln(e.getMessage());
+ }
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see databasebuilder.console.commands.Command#help()
+ */
+ @Override
+ public void help() {
+ Console.println("Usage: exec ");
+ }
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDexit.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDexit.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDexit.java (revision 478)
@@ -0,0 +1,38 @@
+package de.ugoe.cs.util.console.defaultcommands;
+
+import java.util.List;
+
+import de.ugoe.cs.util.console.Command;
+import de.ugoe.cs.util.console.Console;
+
+/**
+ *
+ * Command to terminate an application.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public class CMDexit implements Command {
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see databasebuilder.console.commands.Command#help()
+ */
+ @Override
+ public void help() {
+ Console.println("Usage: exit");
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see de.ugoe.cs.util.console.Command#run(java.util.List)
+ */
+ @Override
+ public void run(List parameters) {
+ System.exit(0);
+ }
+
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/ICommandListener.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/ICommandListener.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/ICommandListener.java (revision 478)
@@ -0,0 +1,25 @@
+package de.ugoe.cs.util.console.listener;
+
+import de.ugoe.cs.util.console.CommandExecuter;
+
+/**
+ *
+ * Interface for listeners observing the commands executed by the
+ * {@link CommandExecuter}.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public interface ICommandListener {
+ /**
+ *
+ * Receives the command strings of all executed by the
+ * {@link CommandExecuter}.
+ *
+ *
+ * @param command
+ * string of the command.
+ */
+ public void commandNotification(String command);
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IErrorListener.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IErrorListener.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IErrorListener.java (revision 478)
@@ -0,0 +1,24 @@
+package de.ugoe.cs.util.console.listener;
+
+import de.ugoe.cs.util.console.Console;
+
+/**
+ *
+ * Interface for listeners observing the error stream of the {@link Console}.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public interface IErrorListener {
+
+ /**
+ *
+ * Receives messages send to the error stream of the {@link Console}.
+ *
+ *
+ * @param errMessage
+ * error message
+ */
+ public void errorMsg(String errMessage);
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IExceptionListener.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IExceptionListener.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IExceptionListener.java (revision 478)
@@ -0,0 +1,24 @@
+package de.ugoe.cs.util.console.listener;
+
+import de.ugoe.cs.util.console.Console;
+
+/**
+ *
+ * Received all exceptions passed to the {@link Console} for logging.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public interface IExceptionListener {
+
+ /**
+ *
+ * Logs an exception passed to the {@link Console}.
+ *
+ *
+ * @param e
+ * Exception that is logged
+ */
+ public void logException(Exception e);
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IOutputListener.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IOutputListener.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/IOutputListener.java (revision 478)
@@ -0,0 +1,25 @@
+package de.ugoe.cs.util.console.listener;
+
+import de.ugoe.cs.util.console.Console;
+
+/**
+ *
+ * Interface for listeners observing the output stream of the {@link Console}.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public interface IOutputListener {
+
+ /**
+ *
+ * Receives messages send to the output stream of the {@link Console}.
+ *
+ *
+ * @param newMessage
+ * message that was send to the console.
+ */
+ public void outputMsg(String newMessage);
+
+}
Index: /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/ITraceListener.java
===================================================================
--- /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/ITraceListener.java (revision 478)
+++ /trunk/java-utils/src/main/java/de/ugoe/cs/util/console/listener/ITraceListener.java (revision 478)
@@ -0,0 +1,23 @@
+package de.ugoe.cs.util.console.listener;
+
+import de.ugoe.cs.util.console.Console;
+
+/**
+ *
+ * Interface for listeners observing traces stream to the {@link Console}.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public interface ITraceListener {
+ /**
+ *
+ * Receives messages send to the trace stream of the {@link Console}.
+ *
+ *
+ * @param traceMessage
+ * error message
+ */
+ public void traceMsg(String traceMessage);
+}