io.gem.api.SshUtils Maven / Gradle / Ivy
/**
* Copyright (c) KMG. All Rights Reserved..
*
* 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
*/
package io.gem.api;
import org.apache.commons.lang3.StringUtils;
import org.apache.sshd.client.SshClient;
import org.apache.sshd.client.channel.ChannelExec;
import org.apache.sshd.client.channel.ClientChannelEvent;
import org.apache.sshd.client.future.ConnectFuture;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.scp.client.ScpClient;
import org.apache.sshd.scp.client.ScpClientCreator;
import org.jetbrains.annotations.NotNull;
import java.io.IOException;
import java.util.EnumSet;
import java.util.Set;
import java.util.concurrent.TimeUnit;
/**
* Class SshUtils.
*/
public final class SshUtils {
/**
* This method is responsible for creating client sessions.
*
* @param client SshClient
* @param connConfig SshConnection
* @param timeoutSeconds long
* @return session
* @throws IOException If it occurs
*/
public static ClientSession createSession(SshClient client, ConnectionConfig connConfig, long timeoutSeconds)
throws IOException {
// Connect to the server
final ConnectFuture cf = client.connect(connConfig.getUserName(), connConfig.getHost(), connConfig.getPort());
final ClientSession session = cf.verify().getSession();
if (StringUtils.isNotEmpty(connConfig.getPassword())) {
session.addPasswordIdentity(connConfig.getPassword());
session.auth().verify(TimeUnit.SECONDS.toMillis(timeoutSeconds));
}
return session;
}
/**
* This method is responsible for running commands.
*
* @param session final NotNull ClientSession
* @param cmd String
* @param timeoutSeconds long
* @param response NotNull SshResponseStream
* @throws IOException If it occurs
*/
public static void runCommand(final @NotNull ClientSession session, String cmd, long timeoutSeconds,
@NotNull SshResponse response) throws IOException {
// Create the exec and channel its output/error streams
final ChannelExec execChannel = session.createExecChannel(cmd);
execChannel.setErr(response.errOutputStream);
execChannel.setOut(response.stdOutputStream);
// Execute and wait
execChannel.open();
final Set events = execChannel.waitFor(EnumSet.of(ClientChannelEvent.CLOSED),
TimeUnit.SECONDS.toMillis(timeoutSeconds));
// Check if timed out
if (events.contains(ClientChannelEvent.TIMEOUT)) {
throw new IOException("The cmd: " + cmd + " timeout !");
}
if (session.isOpen()) {
response.returnCode = execChannel.getExitStatus();
execChannel.close(true);
}
}
/**
* It copies directory of sessions.
*
* @param session final ClientSession
* @param srcPath String
* @param dstPath String
* @throws IOException If it occurs.
*/
public static void copyDirectory(final ClientSession session, String srcPath,
String dstPath) throws IOException {
final ScpClientCreator creator = ScpClientCreator.instance();
final ScpClient scpClient = creator.createScpClient(session);
scpClient.upload(srcPath, dstPath, ScpClient.Option.Recursive, ScpClient.Option.PreserveAttributes,
ScpClient.Option.TargetIsDirectory);
}
}