1 /**
2 * Licensed to jclouds, Inc. (jclouds) under one or more
3 * contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. jclouds licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.jclouds.ssh;
20
21 import javax.annotation.PostConstruct;
22 import javax.annotation.PreDestroy;
23
24 import org.jclouds.compute.domain.ExecResponse;
25 import org.jclouds.domain.Credentials;
26 import org.jclouds.io.Payload;
27 import org.jclouds.net.IPSocket;
28
29 /**
30 * @author Adrian Cole
31 */
32 public interface SshClient {
33
34 interface Factory {
35 /**
36 * please use {@link Factory#create(IPSocket, Credentials)}
37 *
38 * @return
39 */
40 @Deprecated
41 SshClient create(IPSocket socket, String username, String password);
42
43 /**
44 * please use {@link Factory#create(IPSocket, Credentials)}
45 *
46 * @return
47 */
48 @Deprecated
49 SshClient create(IPSocket socket, String username, byte[] privateKey);
50
51 SshClient create(IPSocket socket, Credentials credentials);
52
53 }
54
55 String getUsername();
56
57 String getHostAddress();
58
59 void put(String path, Payload contents);
60
61 Payload get(String path);
62
63 ExecResponse exec(String command);
64
65 @PostConstruct
66 void connect();
67
68 @PreDestroy
69 void disconnect();
70
71 void put(String path, String contents);
72
73 }