alluxio-master-2.x/core/common/src/main/java/alluxio/cli/ValidationTask.java
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.cli;

import org.apache.commons.cli.Option;

import java.util.List;
import java.util.Map;

/**
 * Interface for a validation task run by validateEnv command.
 */
public interface ValidationTask {
  /**
   * Gets the name of the task.
   *
   * @return the task name
   * */
  String getName();

  /**
   * @return Set of {@link Option} required by this task
   */
  List<Option> getOptionList();

  /**
   * Runs the validation task.
   *
   * @param optionMap contains string representation of &lt;key, value&gt; pairs
   * @return the result of validation task
   */
  ValidationTaskResult validate(Map<String, String> optionMap) throws InterruptedException;
}
