gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractKnoxShellCommand.java

/*
 * 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.knox.gateway.shell.commands;

import java.util.List;

import org.apache.knox.gateway.shell.CredentialCollectionException;
import org.apache.knox.gateway.shell.CredentialCollector;
import org.codehaus.groovy.tools.shell.CommandSupport;
import org.codehaus.groovy.tools.shell.Groovysh;

public abstract class AbstractKnoxShellCommand extends CommandSupport {
  static final String KNOXSQLHISTORY = "__knoxsqlhistory";
  protected static final String KNOXDATASOURCES = "__knoxdatasources";
  private String description;
  private String usage;
  private String help;

  public AbstractKnoxShellCommand(Groovysh shell, String name, String shortcut) {
    super(shell, name, shortcut);
  }

  public AbstractKnoxShellCommand(Groovysh shell, String name, String shortcut,
      String desc, String usage, String help) {
    super(shell, name, shortcut);
    this.description = desc;
    this.usage = usage;
    this.help = help;
  }

  @Override
  public String getDescription() {
      return description;
  }

  @Override
  public String getUsage() {
    return usage;
  }

  @Override
  public String getHelp() {
    return help;
  }

  protected String getBindingVariableNameForResultingTable(List<String> args) {
    String variableName = null;
    boolean nextOne = false;
    for (String arg : args) {
      if (nextOne) {
        variableName = arg;
        break;
      }
      if ("assign".equalsIgnoreCase(arg)) {
        nextOne = true;
      }
    }
    return variableName;
  }

  protected CredentialCollector login() throws CredentialCollectionException {
    KnoxLoginDialog dlg = new KnoxLoginDialog();
    dlg.collect();
    return dlg;
  }
}