docs: 补充文档.

补充该类的文档, 为创建 Javadoc 做准备.
This commit is contained in:
LamGC 2021-08-15 14:04:36 +08:00
parent e0a9b933ca
commit dc9c349826
Signed by: LamGC
GPG Key ID: 6C5AE2A913941E1D

View File

@ -1,12 +1,15 @@
package net.lamgc.oracle.sentry.oci.compute.ssh;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.sftp.client.SftpClient;
import org.apache.sshd.sftp.client.SftpClientFactory;
import java.io.Closeable;
import java.io.IOException;
/**
* SSH 连接会话.
* <p> 可与服务器创建多个 SSH 连接会话.
* @author LamGC
*/
@SuppressWarnings("unused")
public class SshSession implements Closeable {
@ -16,10 +19,21 @@ public class SshSession implements Closeable {
this.clientSession = clientSession;
}
/**
* 创建命令执行会话.
* @param command 待执行的命令.
* @return 返回命令执行会话.
* @throws IOException 当会话创建失败时抛出异常.
*/
public CommandExecSession createExecSession(String command) throws IOException {
return new CommandExecSession(clientSession.createExecChannel(command));
}
/**
* 关闭 SSH 连接会话, 该连接会话所属的其他会话将会一同被关闭.
* @throws IOException 关闭失败时抛出异常,
* 可能是由于连接已经被关闭而引起(具体看异常信息).
*/
@Override
public void close() throws IOException {
clientSession.close();