├── LICENSE
├── README.md
├── pom.xml
└── src
├── main
├── java
│ └── com
│ │ └── github
│ │ └── woostju
│ │ └── ssh
│ │ ├── SshClient.java
│ │ ├── SshClientConfig.java
│ │ ├── SshClientEventListener.java
│ │ ├── SshClientFactory.java
│ │ ├── SshClientSSHJ.java
│ │ ├── SshClientState.java
│ │ ├── SshResponse.java
│ │ ├── autoconfigure
│ │ ├── SshClientPoolAutoConfiguration.java
│ │ └── SshClientPoolProperties.java
│ │ ├── exception
│ │ ├── AuthException.java
│ │ ├── LostConnectionException.java
│ │ ├── SshException.java
│ │ └── TimeoutException.java
│ │ └── pool
│ │ ├── SshClientPoolConfig.java
│ │ ├── SshClientWrapper.java
│ │ └── SshClientsPool.java
└── resources
│ └── META-INF
│ └── spring.factories
└── test
└── java
├── com
└── github
│ └── test
│ ├── CustomerSshClient.java
│ ├── TestSshClient.java
│ ├── TestSshClientsPool.java
│ └── multithread
│ ├── JobExecutor.java
│ ├── JobExecutorState.java
│ └── SyncThreadPool.java
├── id_rsa
└── id_rsa.pub
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ssh-client-pool
2 | a java implementation of ssh clients object pool with [sshj](https://github.com/hierynomus/sshj), [apache common pool2](https://github.com/apache/commons-pool), [expectIt](https://github.com/Alexey1Gavrilov/ExpectIt)
3 |
4 |
5 |
6 | ## usage
7 |
8 | ssh-client-pool is available from **Maven Central**
9 |
10 | ```xml
11 |
12 | com.github.woostju
13 | ssh-client-pool
14 | 1.0.1-RELEASE
15 |
16 | ```
17 |
18 | ### Who is this for?
19 |
20 | Anyone who wants to connect server instances through SSH, send commands to server and consume the output continuously.
21 |
22 | Anyone who wants to cache the connected clients in an object pool, to reuse the client.
23 |
24 |
25 | ### How do I use this?
26 |
27 | The SshClientsPool is auto-configured, use it directly as:
28 |
29 | ```java
30 |
31 | @Autowired
32 | SshClientsPool pool;
33 |
34 | public void echo(){
35 | SshClientConfig clientConfig = new SshClientConfig("hostip", 22, "username", "password", null);
36 | SshClientWrapper client = pool.client(clientConfig);
37 | SshResponse response = client.executeCommand("echo 'hi'", 100);
38 | return response;
39 | }
40 |
41 | ```
42 |
43 | ### Can I configure the pool?
44 |
45 | You can configure SshClientsPool in your SpringBoot properties file as:
46 |
47 | ```
48 | woostju.ssh-client-pool.maxActive=16
49 | woostju.ssh-client-pool.maxIdle=16
50 | woostju.ssh-client-pool.idleTime=20000
51 | woostju.ssh-client-pool.maxWait=20000
52 | ```
53 |
54 | what's more, you can also register the SshClientsPool yourself:
55 |
56 | ```java
57 | @Bean
58 | public SshClientsPool sshclientpool() {
59 | SshClientPoolConfig poolConfig = SshClientPoolConfig();
60 | poolConfig.setMaxTotalPerKey(maxTotal);
61 | poolConfig.setMaxIdlePerKey(maxIdle);
62 | poolConfig.setBlockWhenExhausted(true);
63 | poolConfig.setMaxWaitMillis(1000L * maxWaitMillis);
64 |
65 | poolConfig.setMinEvictableIdleTimeMillis(1000L * idleTime);
66 | poolConfig.setTimeBetweenEvictionRunsMillis(1000L * idleTime);
67 | poolConfig.setTestOnBorrow(true);
68 | poolConfig.setTestOnReturn(true);
69 | poolConfig.setTestWhileIdle(true);
70 | poolConfig.setJmxEnabled(false); //disbale jmx
71 |
72 | return new SshClientsPool(poolConfig);
73 | }
74 | ```
75 |
76 | SshClientPoolConfig is a subclass of GenericKeyedObjectPool in Apacha Common Pool2, learn more from [apache common pool2](https://github.com/apache/commons-pool) to configure the pool.
77 |
78 | ### How does it work?
79 |
80 | When you request a client from pool, it will pull an idle one, if there is no idle client, a created one return.
81 | After you execute a command, it will return the client to pool as an idle one.
82 | If you close the client explicitly, the client will be destroyed and remove from pool.
83 |
84 | ## License
85 |
86 | This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
87 |
88 |
89 | ## Additional Resources
90 |
91 | * [hierynomus/sshj](https://github.com/hierynomus/sshj) ssh, scp and sftp for java
92 | * [apache common pool2](https://github.com/apache/commons-pool) The Apache Commons Object Pooling Library.
93 | * [Alexey1Gavrilov/expectIt](https://github.com/Alexey1Gavrilov/ExpectIt) ExpectIt - is yet another pure Java 1.6+ implementation of the Expect tool. It is designed to be simple, easy to use and extensible. Written from scratch.
94 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
4 | 4.0.0
5 | com.github.woostju
6 | ssh-client-pool
7 | jar
8 | 1.0.1-RELEASE
9 | ${project.groupId}:${project.artifactId}
10 | https://github.com/woostju/ssh-client-pool
11 | pool for java ssh client
12 |
13 |
14 |
15 | The Apache Software License, Version 2.0
16 | http://www.apache.org/licenses/LICENSE-2.0.txt
17 | repo
18 |
19 |
20 |
21 |
22 |
23 | James WU
24 | woostju@163.com
25 |
26 |
27 |
28 |
29 | scm:git@github.com:woostju/ssh-client-pool.git
30 | scm:git@github.com:woostju/ssh-client-pool.git
31 | https://github.com/woostju/ssh-client-pool.git
32 |
33 |
34 |
35 |
36 | org.springframework.boot
37 | spring-boot-starter-parent
38 | 1.5.10.RELEASE
39 |
40 |
41 |
42 | UTF-8
43 | UTF-8
44 | 1.8
45 |
46 |
47 |
48 |
49 | com.hierynomus
50 | sshj
51 | 0.26.0
52 |
53 |
54 | org.bouncycastle
55 | bcprov-jdk15on
56 | 1.60
57 |
58 |
59 | com.fasterxml.uuid
60 | java-uuid-generator
61 | 3.1.4
62 |
63 |
64 | net.sf.expectit
65 | expectit-core
66 | 0.9.0
67 |
68 |
69 |
70 | org.apache.commons
71 | commons-pool2
72 | 2.8.0
73 |
74 |
75 | org.springframework.boot
76 | spring-boot-starter-test
77 |
78 |
79 |
80 |
81 |
82 |
83 | org.apache.maven.plugins
84 | maven-source-plugin
85 |
86 |
87 | attach-sources
88 |
89 | jar-no-fork
90 |
91 |
92 |
93 |
94 |
95 | org.apache.maven.plugins
96 | maven-javadoc-plugin
97 |
98 |
99 | attach-javadocs
100 |
101 | jar
102 |
103 |
104 |
105 |
106 |
107 | org.apache.maven.plugins
108 | maven-gpg-plugin
109 | 1.5
110 |
111 |
112 | sign-artifacts
113 | verify
114 |
115 | sign
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 | src/main/java
124 |
125 | **/*.properties
126 | **/*.xml
127 |
128 | false
129 |
130 |
131 | src/main/resources
132 |
133 | **/*
134 |
135 | false
136 |
137 |
138 |
139 |
140 |
141 | release
142 |
143 |
144 |
145 | org.sonatype.plugins
146 | nexus-staging-maven-plugin
147 | 1.6.3
148 | true
149 |
150 | ossrh
151 | https://oss.sonatype.org/
152 | false
153 |
154 |
155 |
156 | org.apache.maven.plugins
157 | maven-release-plugin
158 | 2.5
159 |
160 | true
161 | false
162 | release
163 | deploy
164 |
165 |
166 |
167 | org.apache.maven.plugins
168 | maven-compiler-plugin
169 | 3.0
170 |
171 | 1.8
172 | 1.8
173 |
174 |
175 |
176 | org.apache.maven.plugins
177 | maven-gpg-plugin
178 | 1.5
179 |
180 |
181 | sign-artifacts
182 | verify
183 |
184 | sign
185 |
186 |
187 |
188 |
189 |
190 | org.apache.maven.plugins
191 | maven-source-plugin
192 | 2.2.1
193 |
194 |
195 | attach-sources
196 |
197 | jar-no-fork
198 |
199 |
200 |
201 |
202 |
203 | org.apache.maven.plugins
204 | maven-javadoc-plugin
205 | 2.9
206 |
207 |
208 | attach-javadocs
209 |
210 | jar
211 |
212 |
213 |
214 |
215 |
216 |
217 |
218 |
219 |
220 |
221 | ossrh
222 | https://oss.sonatype.org/content/repositories/snapshots
223 |
224 |
225 | ossrh
226 | https://oss.sonatype.org/service/local/staging/deploy/maven2/
227 |
228 |
229 |
230 |
--------------------------------------------------------------------------------
/src/main/java/com/github/woostju/ssh/SshClient.java:
--------------------------------------------------------------------------------
1 | package com.github.woostju.ssh;
2 |
3 | import com.github.woostju.ssh.exception.SshException;
4 |
5 | /**
6 | * Ssh Client used to connect to server instance and execute command. The build-in implementation is {@link SshClientSSHJ}
7 | *
8 | * Client can be used in chain mode, {@link SshClient}.{@link #init(SshClientConfig)}.{@link #connect(int)}.{@link #authPassword()}.{@link #startSession(boolean)}.{@link #executeCommand(String, int)}
9 | *
10 | * At last, close the client with {@link #disconnect()}
11 | *
12 | *
Set an {@link SshClientEventListener} with {@link #setEventListener(SshClientEventListener)} to be notified when its event occurs
13 | *
14 | * @author jameswu
15 | *
16 | */
17 | public interface SshClient {
18 |
19 | /**
20 | * pass the {@link SshClientConfig} to client
21 | * @param config the information used to connect to server
22 | * @return SshClient itself
23 | */
24 | public SshClient init(SshClientConfig config);
25 |
26 | /**
27 | * connect to server, and timeout if longer than {@code timeoutInSeconds}
28 | * @param timeoutInSeconds timeout in seconds
29 | * @return SshClient itself
30 | * @throws SshException if server is unreachable, usually the host and port is incorrect
31 | */
32 | public SshClient connect(int timeoutInSeconds) throws SshException;
33 |
34 | /**
35 | * auth with password
36 | * @return SshClient itself
37 | * @throws SshException if username or password is incorrect
38 | */
39 | public SshClient authPassword() throws SshException;
40 |
41 | /**
42 | * auth with key
43 | * @return SshClient itself
44 | * @throws SshException if username or public key is incorrect
45 | */
46 | public SshClient authPublickey() throws SshException;
47 |
48 | /**
49 | * start session
50 | * @param shellMode true: communicate with server interactively in session, just like command line
51 | *
false: only execute command once in session
52 | * @return SshClient itself
53 | * @throws SshException when start session failed
54 | *
55 | */
56 | public SshClient startSession(boolean shellMode) throws SshException;
57 |
58 | /**
59 | *
60 | * @param command execute the {@code command} on server instance, and timeout if longer than {@code timeoutInSeconds}.
61 | * @param timeoutInSeconds timeout in seconds
62 | * @return SshResponse
63 | *
64 | */
65 | public SshResponse executeCommand(String command, int timeoutInSeconds);
66 |
67 | /**
68 | * set the listener on SshClient
69 | * @param listener notify listener when events occur in SshClient
70 | * @return SshClient itself
71 | */
72 | public SshClient setEventListener(SshClientEventListener listener);
73 |
74 | /**
75 | * disconnect from server
76 | */
77 | public void disconnect();
78 |
79 | /**
80 | * state of SshClient
81 | *
82 | * @return SshClientState the state of ssh client
83 | *
inited before {@link #startSession(boolean)} success
84 | *
connected after {@link #startSession(boolean)} success
85 | *
disconnected after {@link #disconnect()}, or any connection problem occurs
86 | */
87 | public SshClientState getState();
88 |
89 | }
90 |
--------------------------------------------------------------------------------
/src/main/java/com/github/woostju/ssh/SshClientConfig.java:
--------------------------------------------------------------------------------
1 | package com.github.woostju.ssh;
2 |
3 | /**
4 | *
5 | * Configuration used by {@link SshClient} to connect to remote server instance
6 | *
7 | * @author jameswu
8 | *
9 | */
10 | public class SshClientConfig {
11 | private String host;
12 | private int port;
13 | private String username;
14 | private String password;
15 | private String privateKeyPath;
16 | private String id;
17 |
18 | /**
19 | *
20 | * @return host address
21 | */
22 | public String getHost() {
23 | return host;
24 | }
25 |
26 | /**
27 | * @param host host address, usually the ip address of remote server
28 | */
29 | public void setHost(String host) {
30 | this.host = host;
31 | }
32 |
33 | /**
34 | *
35 | * @return ssh port of the remote server
36 | */
37 | public int getPort() {
38 | return port;
39 | }
40 |
41 | /**
42 | * @param port ssh port of the remote server
43 | */
44 | public void setPort(int port) {
45 | this.port = port;
46 | }
47 |
48 | /**
49 | *
50 | * @return ssh username of the remote server
51 | */
52 | public String getUsername() {
53 | return username;
54 | }
55 |
56 | /**
57 | *
58 | * @param username ssh username of the remote server
59 | */
60 | public void setUsername(String username) {
61 | this.username = username;
62 | }
63 |
64 | /**
65 | *
66 | * @return ssh password of the remote server
67 | */
68 | public String getPassword() {
69 | return password;
70 | }
71 |
72 | /**
73 | *
74 | * @param password ssh password of the remote server
75 | */
76 | public void setPassword(String password) {
77 | this.password = password;
78 | }
79 |
80 | /**
81 | * @return ssh local key file path of the remote server
82 | */
83 | public String getPrivateKeyPath() {
84 | return privateKeyPath;
85 | }
86 |
87 | /**
88 | * @param privateKeyPath local key file path of the remote server
89 | */
90 | public void setPrivateKeyPath(String privateKeyPath) {
91 | this.privateKeyPath = privateKeyPath;
92 | }
93 |
94 | /**
95 | *
96 | * @return id of the config
97 | */
98 | public String getId() {
99 | return id;
100 | }
101 |
102 | /**
103 | *
104 | * @param host server host address
105 | * @param port server ssh port
106 | * @param username server ssh username
107 | * @param password server ssh password
108 | * @param privateKeyPath local security key used to connect to server
109 | */
110 | public SshClientConfig(String host, int port, String username, String password, String privateKeyPath) {
111 | this.id = host + port + username;
112 | if (null != password && password.length() > 0) {
113 | this.id += password;
114 | }
115 | if (privateKeyPath != null) {
116 | this.id += privateKeyPath;
117 | }
118 | this.host = host;
119 | this.port = port;
120 | this.username = username;
121 | this.password = password;
122 | this.privateKeyPath = privateKeyPath;
123 | }
124 |
125 | public SshClientConfig() {
126 |
127 | }
128 |
129 | @Override
130 | public boolean equals(Object obj) {
131 | if (obj instanceof SshClientConfig) {
132 | return id.equals(((SshClientConfig) obj).getId());
133 | }
134 | return false;
135 | }
136 |
137 | @Override
138 | public int hashCode() {
139 | return id.hashCode();
140 | }
141 |
142 | @Override
143 | public String toString() {
144 | return this.id;
145 | }
146 | }
--------------------------------------------------------------------------------
/src/main/java/com/github/woostju/ssh/SshClientEventListener.java:
--------------------------------------------------------------------------------
1 | package com.github.woostju.ssh;
2 |
3 | /**
4 | *
5 | * Set listener to a SshClient by {@link SshClient#setEventListener(SshClientEventListener)}
6 | * @author jameswu
7 | *
8 | */
9 | public interface SshClientEventListener {
10 |
11 | /**
12 | * after SshClient finished executing command
13 | * @param client the ssh client
14 | */
15 | public void didExecuteCommand(Object client);
16 |
17 | /**
18 | * after SshClient disconnnect from the remote server
19 | * @param client the ssh client
20 | */
21 | public void didDisConnected(Object client);
22 |
23 | /**
24 | * after SshClient start the ssh session
25 | * @param client the ssh client
26 | */
27 | public void didConnected(Object client);
28 | }
29 |
--------------------------------------------------------------------------------
/src/main/java/com/github/woostju/ssh/SshClientFactory.java:
--------------------------------------------------------------------------------
1 | package com.github.woostju.ssh;
2 |
3 | import com.github.woostju.ssh.pool.SshClientPoolConfig;
4 |
5 | /**
6 | *
7 | * Factory of {@link SshClient} implementation
8 | *
Create a new instance of {@link SshClientSSHJ} with {@link #newInstance(SshClientConfig)}
9 | *