Mercurial > 510Connectbot
annotate src/com/five_ten_sg/connectbot/transport/AbsTransport.java @ 30:d738f6b876fe tn5250
start tn5250 integration
author | Carl Byington <carl@five-ten-sg.com> |
---|---|
date | Tue, 03 Jun 2014 16:05:21 -0700 |
parents | 017eeed8332c |
children | 139394237973 |
rev | line source |
---|---|
0 | 1 /* |
2 * ConnectBot: simple, powerful, open-source SSH client for Android | |
3 * Copyright 2007 Kenny Root, Jeffrey Sharkey | |
4 * | |
5 * Licensed under the Apache License, Version 2.0 (the "License"); | |
6 * you may not use this file except in compliance with the License. | |
7 * You may obtain a copy of the License at | |
8 * | |
9 * http://www.apache.org/licenses/LICENSE-2.0 | |
10 * | |
11 * Unless required by applicable law or agreed to in writing, software | |
12 * distributed under the License is distributed on an "AS IS" BASIS, | |
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 * See the License for the specific language governing permissions and | |
15 * limitations under the License. | |
16 */ | |
17 | |
18 package com.five_ten_sg.connectbot.transport; | |
19 | |
20 import java.io.IOException; | |
21 import java.util.List; | |
22 import java.util.Map; | |
23 | |
24 import com.five_ten_sg.connectbot.bean.HostBean; | |
25 import com.five_ten_sg.connectbot.bean.PortForwardBean; | |
26 import com.five_ten_sg.connectbot.service.TerminalBridge; | |
29
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
27 import com.five_ten_sg.connectbot.service.TerminalKeyListener; |
0 | 28 import com.five_ten_sg.connectbot.service.TerminalManager; |
29 import android.content.Context; | |
30 import android.net.Uri; | |
29
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
31 import de.mud.terminal.vt320; |
0 | 32 |
33 /** | |
34 * @author Kenny Root | |
35 * | |
36 */ | |
37 public abstract class AbsTransport { | |
38 HostBean host; | |
39 TerminalBridge bridge; | |
40 TerminalManager manager; | |
41 | |
42 String emulation; | |
43 | |
44 public AbsTransport() {} | |
45 | |
46 public AbsTransport(HostBean host, TerminalBridge bridge, TerminalManager manager) { | |
47 this.host = host; | |
48 this.bridge = bridge; | |
49 this.manager = manager; | |
50 } | |
51 | |
52 /** | |
53 * @return protocol part of the URI | |
54 */ | |
55 public static String getProtocolName() { | |
56 return "unknown"; | |
57 } | |
58 | |
11 | 59 |
0 | 60 /** |
61 * Encode the current transport into a URI that can be passed via intent calls. | |
62 * @return URI to host | |
63 */ | |
11 | 64 public abstract Uri getUri(String input); |
65 | |
0 | 66 |
67 /** | |
68 * Causes transport to connect to the target host. After connecting but before a | |
69 * session is started, must call back to {@link TerminalBridge#onConnected()}. | |
70 * After that call a session may be opened. | |
71 */ | |
72 public abstract void connect(); | |
73 | |
74 /** | |
75 * Checks if read() will block. If there are no bytes remaining in | |
76 * the underlying transport, return true. | |
77 */ | |
78 public abstract boolean willBlock(); | |
79 | |
80 /** | |
81 * Reads from the transport. Transport must support reading into a byte array | |
82 * <code>buffer</code> at the start of <code>offset</code> and a maximum of | |
83 * <code>length</code> bytes. If the remote host disconnects, throw an | |
84 * {@link IOException}. | |
85 * @param buffer byte buffer to store read bytes into | |
86 * @param offset where to start writing in the buffer | |
87 * @param length maximum number of bytes to read | |
88 * @return number of bytes read | |
89 * @throws IOException when remote host disconnects | |
90 */ | |
91 public abstract int read(byte[] buffer, int offset, int length) throws IOException; | |
92 | |
93 /** | |
94 * Writes to the transport. If the host is not yet connected, simply return without | |
95 * doing anything. An {@link IOException} should be thrown if there is an error after | |
96 * connection. | |
97 * @param buffer bytes to write to transport | |
98 * @throws IOException when there is a problem writing after connection | |
99 */ | |
100 public abstract void write(byte[] buffer) throws IOException; | |
101 | |
102 /** | |
103 * Writes to the transport. See {@link #write(byte[])} for behavior details. | |
104 * @param c character to write to the transport | |
105 * @throws IOException when there is a problem writing after connection | |
106 */ | |
107 public abstract void write(int c) throws IOException; | |
108 | |
109 /** | |
110 * Flushes the write commands to the transport. | |
111 * @throws IOException when there is a problem writing after connection | |
112 */ | |
113 public abstract void flush() throws IOException; | |
114 | |
115 /** | |
116 * Closes the connection to the terminal. Note that the resulting failure to read | |
117 * should call {@link TerminalBridge#dispatchDisconnect(boolean)}. | |
118 */ | |
119 public abstract void close(); | |
120 | |
121 /** | |
122 * Tells the transport what dimensions the display is currently | |
123 * @param columns columns of text | |
124 * @param rows rows of text | |
125 * @param width width in pixels | |
126 * @param height height in pixels | |
127 */ | |
128 public abstract void setDimensions(int columns, int rows, int width, int height); | |
129 | |
130 public void setOptions(Map<String, String> options) { | |
131 // do nothing | |
132 } | |
133 | |
134 public Map<String, String> getOptions() { | |
135 return null; | |
136 } | |
137 | |
138 public void setCompression(boolean compression) { | |
139 // do nothing | |
140 } | |
141 | |
142 public void setHttpproxy(String httpproxy) { | |
143 // do nothing | |
144 } | |
145 | |
146 public void setUseAuthAgent(String useAuthAgent) { | |
147 // do nothing | |
148 } | |
149 | |
150 public void setEmulation(String emulation) { | |
151 this.emulation = emulation; | |
152 } | |
153 | |
154 public String getEmulation() { | |
155 return emulation; | |
156 } | |
157 | |
158 public void setHost(HostBean host) { | |
159 this.host = host; | |
160 } | |
161 | |
162 public void setBridge(TerminalBridge bridge) { | |
163 this.bridge = bridge; | |
164 } | |
165 | |
166 public void setManager(TerminalManager manager) { | |
167 this.manager = manager; | |
168 } | |
169 | |
170 /** | |
171 * Whether or not this transport type can forward ports. | |
172 * @return true on ability to forward ports | |
173 */ | |
174 public boolean canForwardPorts() { | |
175 return false; | |
176 } | |
177 | |
178 /** | |
179 * Adds the {@link PortForwardBean} to the list. | |
180 * @param portForward the port forward bean to add | |
181 * @return true on successful addition | |
182 */ | |
183 public boolean addPortForward(PortForwardBean portForward) { | |
184 return false; | |
185 } | |
186 | |
187 /** | |
188 * Enables a port forward member. After calling this method, the port forward should | |
189 * be operational iff it could be enabled by the transport. | |
190 * @param portForward member of our current port forwards list to enable | |
191 * @return true on successful port forward setup | |
192 */ | |
193 public boolean enablePortForward(PortForwardBean portForward) { | |
194 return false; | |
195 } | |
196 | |
197 /** | |
198 * Disables a port forward member. After calling this method, the port forward should | |
199 * be non-functioning iff it could be disabled by the transport. | |
200 * @param portForward member of our current port forwards list to enable | |
201 * @return true on successful port forward tear-down | |
202 */ | |
203 public boolean disablePortForward(PortForwardBean portForward) { | |
204 return false; | |
205 } | |
206 | |
207 /** | |
208 * Removes the {@link PortForwardBean} from the available port forwards. | |
209 * @param portForward the port forward bean to remove | |
210 * @return true on successful removal | |
211 */ | |
212 public boolean removePortForward(PortForwardBean portForward) { | |
213 return false; | |
214 } | |
215 | |
216 /** | |
217 * Gets a list of the {@link PortForwardBean} currently used by this transport. | |
218 * @return the list of port forwards | |
219 */ | |
220 public List<PortForwardBean> getPortForwards() { | |
221 return null; | |
222 } | |
223 | |
224 /** | |
225 * Whether or not this transport type can transfer files. | |
226 * @return true on ability to transfer files | |
227 */ | |
228 public boolean canTransferFiles() { | |
229 return false; | |
230 } | |
231 | |
232 /** | |
233 * Downloads the specified remote file to a local folder. | |
234 * @param remoteFile The path to the remote file to be downloaded. Must be non-null. | |
235 * @param localFolder The path to local folder. Null = default external storage folder. | |
236 * @return true on success, false on failure | |
237 */ | |
238 public boolean downloadFile(String remoteFile, String localFolder) { | |
239 return false; | |
240 } | |
241 | |
242 /** | |
243 * Uploads the specified local file to the remote host. | |
244 * @param localFile The path to the local file to be uploaded. Must be non-null. | |
245 * @param remoteFolder The path to the remote directory. Null == default remote directory. | |
246 * @return true on success, false on failure | |
247 */ | |
248 public boolean uploadFile(String localFile, String remoteFile, | |
249 String remoteFolder, String mode) { | |
250 return false; | |
251 } | |
252 | |
253 public abstract boolean isConnected(); | |
254 public abstract boolean isSessionOpen(); | |
255 public abstract boolean isAuthenticated(); | |
256 | |
257 /** | |
258 * @return int default port for protocol | |
259 */ | |
260 public abstract int getDefaultPort(); | |
261 | |
262 /** | |
263 * @param username | |
264 * @param hostname | |
265 * @param port | |
266 * @return | |
267 */ | |
268 public abstract String getDefaultNickname(String username, String hostname, int port); | |
269 | |
270 /** | |
271 * @param uri | |
272 * @param selectionKeys | |
273 * @param selectionValues | |
274 */ | |
275 public abstract void getSelectionArgs(Uri uri, Map<String, String> selection); | |
276 | |
277 /** | |
278 * @param uri | |
279 * @return | |
280 */ | |
281 public abstract HostBean createHost(Uri uri); | |
282 | |
283 /** | |
284 * @param context context containing the correct resources | |
285 * @return string that hints at the format for connection | |
286 */ | |
11 | 287 public abstract String getFormatHint(Context context); |
0 | 288 |
289 /** | |
29
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
290 * @return do we use the network |
0 | 291 */ |
292 public abstract boolean usesNetwork(); | |
29
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
293 |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
294 /** |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
295 * @return do we need a relay object to read from the transport |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
296 * and send the data into the vt320 buffer |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
297 */ |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
298 public boolean needsRelay() { |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
299 return true; |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
300 } |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
301 |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
302 /** |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
303 * @return a key listener |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
304 */ |
30
d738f6b876fe
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
29
diff
changeset
|
305 public TerminalKeyListener getTerminalKeyListener(TerminalManager manager, TerminalBridge bridge, vt320 buffer, String encoding) { |
29
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
306 return new TerminalKeyListener(manager, bridge, buffer, encoding); |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
307 } |
017eeed8332c
start tn5250 integration
Carl Byington <carl@five-ten-sg.com>
parents:
11
diff
changeset
|
308 |
0 | 309 } |