/*
 * Copyright 2016 SimplifyOps, Inc. (http://simplifyops.com)
 *
 * Licensed 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 com.dtolabs.rundeck.plugins.scm;

import com.dtolabs.rundeck.core.plugins.configuration.ConfigurationException;
import com.dtolabs.rundeck.core.plugins.configuration.Property;

import java.io.File;
import java.util.List;
import java.util.Map;

/**
 * Factory interface, used to define a ScmExportPlugin instance.
 */
public interface ScmExportPluginFactory {

    /**
     * Create a plugin instance
     * @param context context
     * @param input input properties
     * @return instance
     * @throws ConfigurationException
     */
    ScmExportPlugin createPlugin(ScmOperationContext context, Map<String, String> input) throws ConfigurationException;

    /**
     * Create a plugin instance
     * @param context context
     * @param input input properties
     * @param initialize it indicates whether to initialize the plugin or not
     * @return instance
     * @throws ConfigurationException
     */
    default ScmExportPlugin createPlugin(ScmOperationContext context, Map<String, String> input, boolean initialize) throws ConfigurationException{
        return createPlugin(context, input);
    }

    /**
     * Return the list of setup properties
     * @param basedir base dir
     * @return property list
     */
    List<Property> getSetupPropertiesForBasedir(File basedir) ;
}
