client.DeploymentClientFactory Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2015 Groupon.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 client;

import net.schmizz.sshj.SSHClient;

/**
 * Factory for creating different types of deployment clients.
 *
 * @author Brandon Arp (barp at groupon dot com)
 */
public interface DeploymentClientFactory {
    /**
     * Creates a DockerDeploymetnClient from an ssh client.
     *
     * @param client the ssh client
     * @return a new {@link DockerDeploymentClient}
     */
    DockerDeploymentClient createDockerClient(SSHClient client);
}