io.gem.api.SshSession 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 io.sbk.system.Printer;
import lombok.Synchronized;
import org.apache.sshd.client.SshClient;
import org.apache.sshd.client.session.ClientSession;
import javax.annotation.concurrent.GuardedBy;
import java.io.IOException;
import java.net.ConnectException;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutorService;
/**
* Class SbkSsh.
*/
final public class SshSession {
/**
* public SshConnection connection.
*/
final public ConnectionConfig connection;
/**
* private SshClient client.
*/
final private SshClient client;
/**
* ExecutorService executor.
*/
final private ExecutorService executor;
/**
* ClientSession session.
*/
@GuardedBy("this")
private ClientSession session;
/**
* This Constructor initializes all values.
*
* @param conn SshConnection
* @param executor ExecutorService
*/
public SshSession(ConnectionConfig conn, ExecutorService executor) {
this.connection = conn;
this.executor = executor;
this.client = SshClient.setUpDefaultClient();
}
@Synchronized
private void createSession(long timeoutSeconds) {
Printer.log.info("SBK-GEM: Ssh Connection to host '" + connection.getHost() + "' starting...");
try {
client.start();
session = SshUtils.createSession(client, connection, timeoutSeconds);
Printer.log.info("SBK-GEM: Ssh Connection to host '" + connection.getHost() + "' Success.");
} catch (IOException e) {
Printer.log.error("SBK-GEM: Ssh Connection to host '" + connection.getHost() + "' time out!");
session = null;
}
}
/**
* This method Creates Sessions.
*
* @param timeoutSeconds long
* @return CompletableFuture
*/
public CompletableFuture createSessionAsync(long timeoutSeconds) {
return CompletableFuture.runAsync(() -> createSession(timeoutSeconds), executor);
}
@Synchronized
private ClientSession getSession() throws ConnectException {
if (session == null) {
String errMgs = "ssh session to host: " + connection.getHost() + " not found!";
throw new ConnectException(errMgs);
}
return session;
}
/**
* This method is responsible for running commands but throws ConnectException if it occurs.
*
* @param cmd String
* @param isOutput Is stdout output is required
* @param timeoutSeconds long
* @return CompletableFuture
* @throws ConnectException If connection exception occurs.
*/
public CompletableFuture runCommandAsync(String cmd, Boolean isOutput, long timeoutSeconds)
throws ConnectException {
final ClientSession sshSession = getSession();
return CompletableFuture.supplyAsync(() -> {
final SshResponse response = new SshResponse(isOutput);
try {
SshUtils.runCommand(sshSession, cmd, timeoutSeconds, response);
} catch (IOException e) {
e.printStackTrace();
}
return response;
}, executor);
}
/**
* It copies directory of sessions but throws ConnectException if it occurs.
*
* @param srcPath String
* @param dstPath String
* @return CompletableFuture
* @throws ConnectException If connection exception occurs.
*/
public CompletableFuture copyDirectoryAsync(String srcPath, String dstPath) throws ConnectException {
final ClientSession sshSession = getSession();
return CompletableFuture.runAsync(() -> {
try {
SshUtils.copyDirectory(sshSession, srcPath, dstPath);
} catch (IOException e) {
e.printStackTrace();
}
}, executor);
}
@Synchronized
private void closeSession() {
if (session != null) {
session.close(true);
session = null;
}
}
/**
* This method is responsible for closing session and stopping the client.
*/
public void stop() {
closeSession();
client.stop();
}
}