null.
* @throws IllegalArgumentException
* if the command is null.
* @throws DuplicatedCommandException
* if the command is already defined
*/
@Override
public void registersCommand(final Command command) throws DuplicatedCommandException,
IllegalArgumentException {
assert command != null;
String name = command.getName();
if (this.commands.containsKey(name)) {
throw new DuplicatedCommandException(name);
} else {
this.commands.put(name, command);
}
}
/**
* * Executes the shell. *
** No exception is thrown. The implementation of the method is responsible * for printing error messages and set the right exit code. *
*/ public abstract void run(); /** * Tests whether a line is a comment or not. * * @param line * the string to be tested * @return true if the line is a comment, false otherwise */ protected boolean isComment(String line) { return REGEX_COMMENT.matcher(line).matches(); } /** * Interpolates variables and special characters in a string. * * @param str * the string to be interpolated * @return a new string with interpolated variables */ @Override public String interpolate(String str) { Matcher m = REGEX_VARIABLE.matcher(str); StringBuffer sb = new StringBuffer(); while (m.find()) { String backslash = m.group(1); String property = m.group(2).replace("$", "\\$"); String name = m.group(3); String value = System.getProperty(name); if (value == null || backslash.length() > 0) { m.appendReplacement(sb, property); } else { m.appendReplacement(sb, value); } } m.appendTail(sb); return sb.toString(); } /** * Sets an exit code and exit the current shell. * * @param status * the optional result value */ @Override public void exit(int status) { this.exitStatus = status; this.isCommandRead = false; // Wait the end of asynchronous commands try { while (this.isAsynchronousCommandInProgress()) { Thread.sleep(1000); } } catch (final InterruptedException e) { // No operation to exit the shell } } /** * Disconnect, if needed, Petals CLI from the current Petals ESB server. */ public void disconnectIfNeeded() { // Disconnect if needed to prevent resource consumption // if the command 'disconnect' was not used try { final ContainerAdministration containerAdministration = PetalsAdministrationFactory .newInstance().newContainerAdministration(); if (containerAdministration.isConnected()) { try { containerAdministration.disconnect(); } catch (final NoConnectionException e) { // NOP: No connection previously established } catch (final ContainerAdministrationException e) { this.errStream .println("WARNING: The following error occurs disconnection Petals CLI from the Petals ESB container: " + e.getMessage()); e.printStackTrace(this.errStream); } } } catch (final Exception e) { this.errStream .println("WARNING: The following error occurs checking if a connection is established before to force the disconnection: " + e.getMessage()); e.printStackTrace(this.errStream); } } /** * Evaluates a list of arguments. *Does nothing if args id null of empty.
* * @param args * the command line. Not empty and not null. * @throws UnknownCommandException * when the command was not found * @throws CommandException * when an error occurs during the execution of the command */ protected void evaluate(String[] args) throws UnknownCommandException, CommandException { assert (args != null && args.length > 0); String cmdName = args[0]; Command cmd; if (this.commands.containsKey(cmdName)) { cmd = this.commands.get(cmdName); } else { throw new UnknownCommandException(cmdName); } String[] nargs = new String[args.length - 1]; for (int i = 0; i < nargs.length; i++) { nargs[i] = this.interpolate(args[i + 1]); } try { cmd.execute(nargs); } finally { cmd.resetOptions(); } } /** * Evaluates a command line. *Does nothing if the line is a comment.
* * @see #isComment(String) * @param line * the line to be evaluated * @throws UnknownCommandException * when the command was not found * @throws CommandException * when an error occurs during the execution of the command */ protected final void evaluate(String line) throws UnknownCommandException, CommandException { if (!this.isComment(line)) { String[] args = Utils.getLineArgs(line); this.evaluate(args); } } /** * Gets the output stream where anything can be written, mainly by commands. * @return The output stream. */ @Override public PrintStream getPrintStream() { return this.printStream; } public PrintStream getErrorStream() { return this.errStream; } public int getExitStatus() { return this.exitStatus; } @Override public void setExitStatus(int exitStatus) { this.exitStatus = exitStatus; } /** * Prints the error message of a command syntax error. ** The message is made up of the command name, * the syntax error message and the command usage. *
* * @param ce * The command syntax error to print */ public void printCommandSyntaxError(final CommandInvalidException ce) { final Command command = ce.getCommand(); if (command != null) { this.errStream.println("ERROR on command '" + ce.getCommand().getName() + "': " + ce.getMessage()); this.errStream.println(ce.getCommand().getUsage()); } else { this.errStream.println("ERROR: " + ce.getMessage()); } } /** * Prints the error message of a command execution error. ** The message is made up of the command name, the execution error message and, if debug * mode is enable, the stack trace. *
* * @param ce * The command syntax error to print */ public void printCommandExecutionError(final CommandException ce) { final Command command = ce.getCommand(); if (command != null) { this.errStream.println("ERROR on command '" + ce.getCommand().getName() + "': " + ce.getMessage()); } else { this.errStream.println("ERROR: " + ce.getMessage()); } if (this.isDebugModeEnable) { ce.printStackTrace(this.errStream); } } /** * Prints an error message. *If the debug mode is enabled, the stack trace is also printed.
* * @param error * The error. The message to print will be extracted from * {@link Throwable#getMessage()}. */ public void printError(final Throwable error) { this.printError(error, "ERROR: " + error.getMessage()); } /** * Prints an error message. *If the debug mode is enabled, the stack trace is also printed.
* * @param error * The error * @param msg * The message to print. */ public void printError(final Throwable error, final String msg) { this.errStream.println(msg); if (this.isDebugModeEnable) { error.printStackTrace(this.errStream); } } /** * @return true if the debug mode is enabled, false otherwise */ @Override public boolean isDebugModeEnable() { return this.isDebugModeEnable; } @Override public String askQuestion(String question, boolean isReplyPassword) throws NoInteractiveShellException, ShellException { throw new NoInteractiveShellException(); } /** * {@inheritDoc} * ** Special notes for the implementation {@link AbstractShell}: *
true if the 'yes' flag is enable.