org.dromara.hutool.extra.ssh.Connector Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* 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 org.dromara.hutool.extra.ssh;
/**
* 连接者对象，提供一些连接的基本信息，包括：
*
* - host：主机名
* - port：端口
* - user：用户名（默认root）
* - password：密码
* - timeout：连接超时毫秒数
*
*
* @author looly
*/
public class Connector {
/**
* 创建Connector，所有参数为默认，用于构建模式
*
* @return Connector
*/
public static Connector of() {
return new Connector();
}
/**
* 创建Connector
*
* @param host 主机名
* @param port 端口
* @param user 用户名
* @param password 密码
* @return Connector
*/
public static Connector of(final String host, final int port, final String user, final String password) {
return of(host, port, user, password, 0);
}
/**
* 创建Connector
*
* @param host 主机名
* @param port 端口
* @param user 用户名
* @param password 密码
* @param timeout 连接超时时长，0表示默认
* @return Connector
*/
public static Connector of(final String host, final int port, final String user, final String password, final long timeout) {
return new Connector(host, port, user, password, timeout);
}
private String host;
private int port;
private String user = "root";
private String password;
private long timeout;
/**
* 构造
*/
public Connector() {
}
/**
* 构造
*
* @param host 主机名
* @param port 端口
* @param user 用户名
* @param password 密码
* @param timeout 连接超时时长，0表示默认
*/
public Connector(final String host, final int port, final String user, final String password, final long timeout) {
this.host = host;
this.port = port;
this.user = user;
this.password = password;
this.timeout = timeout;
}
/**
* 获得主机名
*
* @return 主机名
*/
public String getHost() {
return host;
}
/**
* 设定主机名
*
* @param host 主机名
* @return this
*/
public Connector setHost(final String host) {
this.host = host;
return this;
}
/**
* 获得端口号
*
* @return 端口号
*/
public int getPort() {
return port;
}
/**
* 设定端口号
*
* @param port 端口号
* @return this
*/
public Connector setPort(final int port) {
this.port = port;
return this;
}
/**
* 获得用户名
*
* @return 用户名
*/
public String getUser() {
return user;
}
/**
* 设定用户名
*
* @param name 用户名
* @return this
*/
public Connector setUser(final String name) {
this.user = name;
return this;
}
/**
* 获得密码
*
* @return 密码
*/
public String getPassword() {
return password;
}
/**
* 设定密码
*
* @param password 密码
* @return this
*/
public Connector setPassword(final String password) {
this.password = password;
return this;
}
/**
* 获得连接超时时间
*
* @return 连接超时时间
*/
public long getTimeout() {
return timeout;
}
/**
* 设置连接超时时间
*
* @param timeout 连接超时时间
* @return this
*/
public Connector setTimeout(final long timeout) {
this.timeout = timeout;
return this;
}
/**
* toString方法仅用于测试显示
*/
@Override
public String toString() {
return "Connector{" +
"host='" + host + '\'' +
", port=" + port +
", user='" + user + '\'' +
", password='" + password + '\'' +
", timeout=" + timeout +
'}';
}
}