oracle.kv.util.shell.ShellCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-server Show documentation
Show all versions of oracle-nosql-server Show documentation
NoSQL Database Server - supplies build and runtime support for the server (store) side of the Oracle NoSQL Database.
/*-
* Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This file was distributed by Oracle as part of a version of Oracle NoSQL
* Database made available at:
*
* http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
*
* Please see the LICENSE file included in the top-level directory of the
* appropriate version of Oracle NoSQL Database for a copy of the license and
* additional information.
*/
package oracle.kv.util.shell;
import java.rmi.RemoteException;
import java.util.Set;
import oracle.kv.impl.admin.CommandJsonUtils;
import oracle.kv.impl.admin.CommandServiceAPI;
import oracle.kv.impl.admin.client.CommandUtils;
import oracle.kv.impl.topo.AdminId;
import oracle.kv.impl.topo.ArbNodeId;
import oracle.kv.impl.topo.DatacenterId;
import oracle.kv.impl.topo.DatacenterType;
import oracle.kv.impl.topo.RepGroupId;
import oracle.kv.impl.topo.RepNodeId;
import oracle.kv.impl.topo.StorageNodeId;
import oracle.kv.util.shell.Shell.VariablesMap;
/**
* Base abstract class for all shell commands.
*/
public abstract class ShellCommand implements Cloneable {
/* Convenience */
protected final static String eol = Shell.eol;
protected final static String eolt = Shell.eolt;
/* The command name */
protected final String name;
/*
* The number of characters which must match when matching the
* command name.
*/
protected final int prefixMatchLength;
protected VariablesMap cmdVariables = null;
protected int exitCode = Shell.EXIT_OK;
private String prompt = null;
/* The command line with the command name stripped */
private String cmdLine = null;
/*
* Indicates whether this command or its subcommands would like to parse
* the "-json" flag in own way.
*/
protected boolean overrideJsonFlag = false;
/**
* Constructor.
*
* @param name the command name
* @param prefixMatchLength number of characters to match the name
*/
protected ShellCommand(String name, int prefixMatchLength) {
assert name.length() >= prefixMatchLength;
this.name = name;
this.prefixMatchLength = prefixMatchLength;
this.cmdVariables = new VariablesMap();
}
/**
* Returns true if the command is hidden. The default implementation
* returns false.
*
* @return true if the command is hidden
*/
protected boolean isHidden() {
return false;
}
/**
* Returns true if the command is deprecated. The default implementation
* returns false.
*
* @return true if the command is deprecated
*/
protected boolean isDeprecated() {
return false;
}
/**
* Gets the command name. The default implementation returns the name
* parameter specified in the constructor.
*
* @return the command name
*/
public String getCommandName() {
return name;
}
/**
* Gets the string describing the command's syntax. The default
* implementation returns the string returned by getCommandName().
*
* @return the command syntax
*/
protected String getCommandSyntax() {
return getCommandName();
}
/**
* Gets the string description for this command.
*
* @return the command description
*/
protected abstract String getCommandDescription();
/**
* Returns true if the specified command name matches this command.
*
* @param commandName the command name
* @return true if the specified command name matches this command
*/
protected boolean matches(String commandName) {
return Shell.matches(commandName, name, prefixMatchLength);
}
/**
* Execute this command.
*
* @param args
* @param shell
* @return the result of the command
* @throws ShellException
*/
public abstract String execute(String[] args, Shell shell)
throws ShellException;
/**
* Execute this command, the command line is passed in.
*/
public String execute(String[] args, Shell shell, String line)
throws ShellException {
/* Strips the command name from the beginning of command line */
if (line != null && line.length() > args[0].length()) {
cmdLine = line.substring(args[0].length()).trim();
}
return execute(args, shell);
}
/**
* Gets the command line which remove the command name
*/
public String getCommandLine() {
return cmdLine != null ? cmdLine : "";
}
/**
* Gets the help string based on the specified arguments. The default
* implementation returns string returned by getVerboseHelp(), ignoring
* the input arguments.
*
* @param args
* @param shell
* @return the help string
*/
protected String getHelp(String[] args, Shell shell) {
return getVerboseHelp();
}
/**
* Gets an expanded help string. The default implementation returns the
* string returned by getBriefHelp() followed by EOL, TAB, then the string
* returned by getCommandDescription().
*
* @return the help string
*/
protected String getVerboseHelp() {
return getBriefHelp() + eolt + getCommandDescription();
}
/**
* Gets an abbreviated help string. The default implementation returns
* the string "Usage: " followed by the string returned by
* getCommandSyntax().
*
* @return an abbreviated help string
*/
protected String getBriefHelp() {
return "Usage: " + getCommandSyntax();
}
/**
* Set a customized prompt string.
*/
public void setPrompt(String myPrompt) {
prompt = myPrompt;
}
/**
* Gets a customized prompt string.
*
* @return the prompt string
*/
public String getPrompt() {
return prompt;
}
@Override
public ShellCommand clone() {
try {
ShellCommand cmd = (ShellCommand) super.clone();
cmd.cmdVariables = this.cmdVariables.clone();
return cmd;
} catch (CloneNotSupportedException neverHappens) {
return null;
}
}
/**
* Store a variable.
*/
public void addVariable(String varName, Object value) {
cmdVariables.add(varName, value);
}
/**
* Remove a variable.
*/
public void removeVariable(String varName) {
cmdVariables.remove(varName);
}
/**
* Remove all variables.
*/
public void clearVariables() {
cmdVariables.reset();
}
/**
* Get the value of a variable.
*/
public Object getVariable(String varName) {
return cmdVariables.get(varName);
}
public void invalidArgument(String arg)
throws ShellException {
String msg = "Invalid argument: " + arg + eolt + getBriefHelp();
throw new ShellArgumentException(msg);
}
// TODO: Maybe provide an overloading of these methods that allows the
// caller to identify the argument if there is a failure?
/**
* Parses the string argument as a signed decimal integer. Throws a
* ShellArgumentException with the brief command help if the argument
* does not contain a parseable int.
*/
public int parseInt(String arg)
throws ShellException {
try {
return Integer.parseInt(arg);
} catch (NumberFormatException nfe) {
invalidArgument(arg);
}
return 0; /* Not reached */
}
/**
* Parses the string argument as a unsigned (positive) decimal integer.
* Throws a ShellArgumentException with the brief command help if the
* argument does not contain a parseable int or the value is < 0.
*/
public int parseUnsignedInt(String arg)
throws ShellException {
final int value = parseInt(arg);
if (value < 0) {
invalidArgument(arg);
}
return value;
}
/**
* Parses the string argument as a signed decimal long. Throws a
* ShellArgumentException with the brief command help if the argument
* does not contain a parseable long.
*/
public long parseLong(String arg)
throws ShellException {
try {
return Long.parseLong(arg);
} catch (NumberFormatException nfe) {
invalidArgument(arg);
}
return 0; /* Not reached */
}
/**
* Parses the string argument as a unsigned (positive) decimal long.
* Throws a ShellArgumentException with the brief command help if the
* argument does not contain a parseable long or the value is < 0.
*/
public long parseUnsignedLong(String arg)
throws ShellException {
final long value = parseLong(arg);
if (value < 0) {
invalidArgument(arg);
}
return value;
}
public int getExitCode() {
return exitCode;
}
public boolean overrideJsonFlag() {
return overrideJsonFlag;
}
protected void validateRepNodes(CommandServiceAPI cs, Set rnids)
throws RemoteException, ShellException {
for (RepNodeId rnid : rnids) {
CommandUtils.ensureRepNodeExists(rnid, cs, this);
}
}
protected StorageNodeId parseSnid(String idString)
throws ShellException {
try {
return StorageNodeId.parse(idString);
} catch (IllegalArgumentException ignored) {
throw new ShellUsageException(
"Invalid storage node ID: " + idString, this);
}
}
protected DatacenterId parseDatacenterId(String idString)
throws ShellException {
try {
return DatacenterId.parse(idString);
} catch (IllegalArgumentException ignored) {
throw new ShellUsageException(
"Invalid zone ID: " + idString, this);
}
}
protected RepGroupId parseShardId(String idString)
throws ShellException {
try {
return RepGroupId.parse(idString);
} catch (IllegalArgumentException ignored) {
throw new ShellUsageException(
"Invalid shard ID: " + idString, this);
}
}
protected RepNodeId parseRnid(String idString)
throws ShellException {
try {
return RepNodeId.parse(idString);
} catch (IllegalArgumentException ignored) {
throw new ShellUsageException(
"Invalid RepNode ID: " + idString, this);
}
}
protected ArbNodeId parseAnid(String idString)
throws ShellException {
try {
return ArbNodeId.parse(idString);
} catch (IllegalArgumentException ignored) {
throw new ShellUsageException(
"Invalid ArbNode ID: " + idString, this);
}
}
protected AdminId parseAdminid(String idString)
throws ShellException {
try {
return AdminId.parse(idString);
} catch (IllegalArgumentException ignored) {
throw new ShellUsageException(
"Invalid Admin ID: " + idString, this);
}
}
protected DatacenterType parseDatacenterType(final String string)
throws ShellException {
try {
return DatacenterType.valueOf(string.toUpperCase());
} catch (IllegalArgumentException ignored) {
throw new ShellUsageException("Invalid zone type: " + string,
this);
}
}
/*
* Returns true if the command accepts input with multiple lines. If true,
* the command requires the terminating character ";" to indicate the end
* of input.
*/
protected boolean isMultilineInput() {
return false;
}
/**
* This method is used to execute the shell command and return the general
* POJO class which can then be used to convert execution result to JSON
* output. A command support JSON output must override this method and
* construct result information into ShellCommandResult for return, so
* that on the top level command shell can output the JSON string in a
* consistent structure.
* @param args
* @param shell
*/
public ShellCommandResult executeJsonOutput(String[] args, Shell shell)
throws ShellException {
throw new ShellException(ShellCommandResult.UNSUPPORTED_MESSAGE);
}
/**
* This utility interface is used to define the common execution path for
* shell command. There are two types of output to display after command
* execution. The first type is formatted string output, the second type
* string represents JSON object. The two types of output will return
* different types of result from execution. Implementation of execute()
* method will handle the formatted string output, "executeJsonOutput()"
* method will handle the JSON output. The implementation of
* commonExecute() is used to merge the common part of code for two
* different output types. For each of the shell command sub class, the
* common can be moved to the commonExceute method, whenever there is a
* need to return a display result, one or more abstract methods with
* generic return type can be defined in the sub class. The different
* execution method will in charge of its own types of result display
* only. See ShowCommand for detailed usage example.
*/
public interface Executor {
public abstract R commonExecute(String[] args, Shell shell)
throws ShellException;
}
/**
* This command implements the handling logic for converting
* previous V1 JSON result from execute() method to the new JSON format
* fits ShellCommandResult.
*/
public static abstract class
ShellCommandJsonConvert extends ShellCommand {
public ShellCommandJsonConvert(String name,
int prefixMatchLength) {
super(name, prefixMatchLength);
}
@Override
public ShellCommandResult
executeJsonOutput(String[] args, Shell shell)
throws ShellException {
return filterJsonResult(execute(args, shell));
}
}
protected ShellCommandResult
filterJsonResult(String result)
throws ShellException {
return CommandJsonUtils.
handleConversionFailure((CommandJsonUtils.
JsonConversionTask)() -> {
return ShellCommandResult.filterJsonV1Result(result);
});
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy