SessionStore (orion-kit 2.0.1 API)

java.lang.Object
- cn.orionsec.kit.net.host.SessionStore

All Implemented Interfaces:

SafeCloseable, Closeable, AutoCloseable
```
public class SessionStore
extends Object
implements SafeCloseable
```
Session Store

Since:

2020/10/5 23:08

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields
Modifier and Type Field and Description

protected com.jcraft.jsch.Session session
session

Fields
Modifier and Type	Field and Description
`protected com.jcraft.jsch.Session`	`session` session

Constructor Summary

Constructors
Constructor and Description

SessionStore(com.jcraft.jsch.Session session)

Constructors
Constructor and Description
`SessionStore(com.jcraft.jsch.Session session)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SessionStore`	`clientVersion(String version)` 设置客户端版本
`void`	`close()` 安全关闭
`SessionStore`	`config(String key, String value)` 设置属性
`SessionStore`	`connect()` 建立连接
`SessionStore`	`connect(int timeout)` 建立连接
`SessionStore`	`daemonThread(boolean daemon)` 设置是否守护进程
`void`	`disconnect()` 关闭连接
`CommandExecutor`	`getCommandExecutor(byte[] command)` 获取 CommandExecutor
`CommandExecutor`	`getCommandExecutor(String command)`
`CommandExecutor`	`getCommandExecutor(String command, String charset)`
`String`	`getConfig(String key)` 获取配置信息
`String`	`getHost()`
`int`	`getPort()`
`com.jcraft.jsch.Session`	`getSession()` 获取 session
`SftpExecutor`	`getSftpExecutor()`
`SftpExecutor`	`getSftpExecutor(String fileNameCharset)` 获取 SftpExecutor
`ShellExecutor`	`getShellExecutor()` 获取 ShellExecutor
`String`	`getUsername()`
`SessionStore`	`httpProxy(String host, int port)`
`SessionStore`	`httpProxy(String host, int port, String username, String password)`
`boolean`	`isConnected()`
`SessionStore`	`password(byte[] password)` 设置密码
`SessionStore`	`password(String password)` 设置密码
`SessionStore`	`proxy(SessionProxyType type, String host, int port)`
`SessionStore`	`proxy(SessionProxyType type, String host, int port, String username, String password)` 设置代理
`void`	`setConfig(String key, String value)` 设置配置信息
`void`	`setHost(String host)`
`void`	`setPort(int port)`
`SessionStore`	`socks4Proxy(String host, int port)`
`SessionStore`	`socks4Proxy(String host, int port, String username, String password)`
`SessionStore`	`socks5Proxy(String host, int port)`
`SessionStore`	`socks5Proxy(String host, int port, String username, String password)`
`SessionStore`	`timeout(int timeout)` 设置连接超时时间

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

session

protected final com.jcraft.jsch.Session session

session

Constructor Detail

SessionStore

public SessionStore(com.jcraft.jsch.Session session)

Method Detail

config

public SessionStore config(String key,
                           String value)

设置属性

Parameters:: key - key; value - value
Returns:: this

password
```
public SessionStore password(String password)
```
设置密码

Parameters:

password - 密码

Returns:

this

password
```
public SessionStore password(byte[] password)
```
设置密码

Parameters:

password - 密码

Returns:

this

httpProxy

public SessionStore httpProxy(String host,
                              int port)

httpProxy

public SessionStore httpProxy(String host,
                              int port,
                              String username,
                              String password)

socks4Proxy

public SessionStore socks4Proxy(String host,
                                int port)

socks4Proxy

public SessionStore socks4Proxy(String host,
                                int port,
                                String username,
                                String password)

socks5Proxy

public SessionStore socks5Proxy(String host,
                                int port)

socks5Proxy

public SessionStore socks5Proxy(String host,
                                int port,
                                String username,
                                String password)

proxy

public SessionStore proxy(SessionProxyType type,
                          String host,
                          int port)

proxy

public SessionStore proxy(SessionProxyType type,
                          String host,
                          int port,
                          String username,
                          String password)

设置代理

Parameters:: type - 代理类型; host - 代理地址; port - 代理端口; username - 代理用户名; password - 代理密码
Returns:: this

clientVersion
```
public SessionStore clientVersion(String version)
```
设置客户端版本

Parameters:

version - 版本

Returns:

this

daemonThread
```
public SessionStore daemonThread(boolean daemon)
```
设置是否守护进程

Parameters:

daemon - true守护进程

Returns:

this

getConfig
```
public String getConfig(String key)
```
获取配置信息

Parameters:

key - key

Returns:

value

setConfig

public void setConfig(String key,
                      String value)

设置配置信息

Parameters:: key - key; value - value

timeout
```
public SessionStore timeout(int timeout)
```
设置连接超时时间

Parameters:

timeout - 超时时间

Returns:

this

connect
```
public SessionStore connect()
```
建立连接

Returns:

this

connect
```
public SessionStore connect(int timeout)
```
建立连接

Parameters:

timeout - 超时时间

Returns:

this

getCommandExecutor

public CommandExecutor getCommandExecutor(String command)

getCommandExecutor

public CommandExecutor getCommandExecutor(String command,
                                          String charset)

getCommandExecutor
```
public CommandExecutor getCommandExecutor(byte[] command)
```
获取 CommandExecutor

Parameters:

command - 命令

Returns:

CommandExecutor

getShellExecutor
```
public ShellExecutor getShellExecutor()
```
获取 ShellExecutor

Returns:

ShellExecutor

getSftpExecutor
```
public SftpExecutor getSftpExecutor()
```

getSftpExecutor
```
public SftpExecutor getSftpExecutor(String fileNameCharset)
```
获取 SftpExecutor

Parameters:

fileNameCharset - 文件名称编码

Returns:

SftpExecutor

disconnect
```
public void disconnect()
```
关闭连接

isConnected
```
public boolean isConnected()
```
Returns:

是否已建立连接

getSession

public com.jcraft.jsch.Session getSession()

获取 session

Returns:: Session

getHost
```
public String getHost()
```

setHost
```
public void setHost(String host)
```

getPort
```
public int getPort()
```

setPort
```
public void setPort(int port)
```

getUsername
```
public String getUsername()
```

close
```
public void close()
```
Description copied from interface: SafeCloseable

安全关闭

Specified by:

close in interface SafeCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Class SessionStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

session

Constructor Detail

SessionStore

Method Detail

config

password

password

httpProxy

httpProxy

socks4Proxy

socks4Proxy

socks5Proxy

socks5Proxy

proxy

proxy

clientVersion

daemonThread

getConfig

setConfig

timeout

connect

connect

getCommandExecutor

getCommandExecutor

getCommandExecutor

getShellExecutor

getSftpExecutor

getSftpExecutor

disconnect

isConnected

getSession

getHost

setHost

getPort

setPort

getUsername

close