/**
*
* 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.airavata.accountprovisioning;

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

public interface SSHAccountProvisionerProvider {

    /**
     * An identifying name for the SSHAccountProvisioner instances created by this provider.
     * This name should be unique amongst all SSHAccountProvisioner implementations.
     */
    default String getName() {
        return this.getClass().getName();
    }

    /**
     * Return the {@link ConfigParam}s for the associated SSHAccountProvisioner.
     * @return
     */
    List<ConfigParam> getConfigParams();

    /**
     * Instantiate and initialize the associated SSHAccountProvisioner.
     * @param config
     * @return
     */
    SSHAccountProvisioner createSSHAccountProvisioner(Map<ConfigParam, String> config);

    /**
     * Return true if the associated SSHAccountProvisioner can create accounts for a user on a compute host.
     * @return
     */
    boolean canCreateAccount();

    /**
     * Return true if the associated SSHAccountProvisioner can install an SSH public key on a compute host for the user.
     * @return
     */
    boolean canInstallSSHKey();
}
