slider-core/src/main/java/org/apache/slider/common/params/ActionClientArgs.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.slider.common.params;

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;

import java.io.File;

@Parameters(commandNames = {SliderActions.ACTION_CLIENT},
    commandDescription = SliderActions.DESCRIBE_ACTION_CLIENT)

public class ActionClientArgs extends AbstractActionArgs {

  @Override
  public String getActionName() {
    return SliderActions.ACTION_CLIENT;
  }

  @Parameter(names = {ARG_INSTALL},
      description = "Install client")
  public boolean install;

  @Parameter(names = {ARG_GETCERTSTORE},
      description = "Get a certificate store")
  public boolean getCertStore;

  @Parameter(names = {ARG_KEYSTORE},
      description = "Retrieve keystore to specified location")
  public File keystore;

  @Parameter(names = {ARG_TRUSTSTORE},
      description = "Retrieve truststore to specified location")
  public File truststore;

  @Parameter(names = {ARG_HOSTNAME},
      description = "(Optional) Specify the hostname to use for generation of keystore certificate")
  public String hostname;

  @Parameter(names = {ARG_NAME},
      description = "The name of the application")
  public String name;

  @Parameter(names = {ARG_PROVIDER},
      description = "The credential provider in which the password is stored")
  public String provider;

  @Parameter(names = {ARG_ALIAS},
      description = "The credential provider alias associated with the password")
  public String alias;

  @Parameter(names = {ARG_PASSWORD},
      description = "The certificate store password (alternative to " +
          "provider/alias; if password is specified, those will be ignored)")
  public String password;

  @Parameter(names = {ARG_PACKAGE},
      description = "Path to app package")
  public String packageURI;

  @Parameter(names = {ARG_DEST},
      description = "The location where to install the client")
  public File installLocation;

  @Parameter(names = {ARG_CONFIG},
      description = "Client configuration")
  public File clientConfig;

  /**
   * Get the min #of params expected
   *
   * @return the min number of params in the {@link #parameters} field
   */
  public int getMinParams() {
    return 0;
  }

  @Override
  public int getMaxParams() {
    return 1;
  }
}