/*
 * 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.flink.client.cli;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
import org.apache.flink.client.program.ClusterClient;
import org.apache.flink.configuration.Configuration;

import java.net.URL;
import java.util.List;


/**
 * Custom command-line interface to load hooks for the command-line interface.
 */
public interface CustomCommandLine<ClusterType extends ClusterClient> {

	/**
	 * Signals whether the custom command-line wants to execute or not
	 * @param commandLine The command-line options
	 * @param configuration The Flink configuration
	 * @return True if the command-line wants to run, False otherwise
	 */
	boolean isActive(CommandLine commandLine, Configuration configuration);

	/**
	 * Gets the unique identifier of this CustomCommandLine
	 * @return A unique identifier
	 */
	String getId();

	/**
	 * Adds custom options to the existing run options.
	 * @param baseOptions The existing options.
	 */
	void addRunOptions(Options baseOptions);

	/**
	 * Adds custom options to the existing general options.
	 * @param baseOptions The existing options.
	 */
	void addGeneralOptions(Options baseOptions);

	/**
	 * Retrieves a client for a running cluster
	 * @param commandLine The command-line parameters from the CliFrontend
	 * @param config The Flink config
	 * @return Client if a cluster could be retrieved
	 * @throws UnsupportedOperationException if the operation is not supported
	 */
	ClusterType retrieveCluster(
			CommandLine commandLine,
			Configuration config) throws UnsupportedOperationException;

	/**
	 * Creates the client for the cluster
	 * @param applicationName The application name to use
	 * @param commandLine The command-line options parsed by the CliFrontend
	 * @param config The Flink config to use
	 * @param userJarFiles User jar files to include in the classpath of the cluster.
	 * @return The client to communicate with the cluster which the CustomCommandLine brought up.
	 * @throws Exception if the cluster could not be created
	 */
	ClusterType createCluster(
			String applicationName,
			CommandLine commandLine,
			Configuration config,
			List<URL> userJarFiles) throws Exception;
}