summaryrefslogtreecommitdiff
path: root/src/plugins/android/src/com/motorola/studio/android/utilities/TelnetFrameworkAndroid.java
blob: f92a1a32af4b61f4d68d4a6edc04af3778fc280a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/*
 * Copyright (C) 2012 The Android Open Source Project
 *
 * 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 com.motorola.studio.android.utilities;

import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.PrintWriter;

import org.apache.commons.net.telnet.TelnetClient;

/**
 * DESCRIPTION: This class defines the framework for telnet services to
 * comunicate with phoe or emulator devices. <BR>
 * RESPONSIBILITY: Provide telnet connection <BR>
 * COLABORATORS: none <BR>
 * USAGE: This class should be instantiated whenever a telnet connection to a
 * phone or emulator device is needed. <BR>
 */
public class TelnetFrameworkAndroid
{

    //private InputStreamReader responseReader;

    //private PrintWriter commandWriter;

    private TelnetClient telnetClient;

    private long timeout = 5000L;

    /**
     * Connect to a device using telnet.
     * 
     * @param telnetHost
     *            the telnet host IP address
     * @param telnetPort
     *            the telnet port
     * 
     * @throws MotodevException
     *             when the connection cannot be established
     */
    public synchronized void connect(String telnetHost, int telnetPort) throws IOException
    {
        if ((telnetClient == null) || ((telnetClient != null) && (!telnetClient.isConnected())))
        {
            telnetClient = new TelnetClient(telnetHost);
            telnetClient.connect(telnetHost, telnetPort);
        }
    }

    /**
     * Disconnect a telnet connection to a device
     * 
     * @throws MotodevException
     *             when the disconnection cannot be executed
     */
    public synchronized void disconnect() throws IOException
    {
        if ((telnetClient != null) && (telnetClient.isConnected()))
        {
            telnetClient.disconnect();
        }
    }

    /**
     * @return 
     *
     */
    public synchronized String write(String telnetInputText, String[] waitFor) throws IOException
    {
        PrintWriter commandWriter = null;
        try
        {
            commandWriter = new PrintWriter(telnetClient.getOutputStream());
            commandWriter.println(telnetInputText);
            commandWriter.flush();
            if (waitFor != null)
            {
                return waitFor(waitFor);
            }
        }
        finally
        {
            if (commandWriter != null)
            {
                commandWriter.close();
            }
        }

        return null;
    }

    /**
     * Tests if the telnet client instance is connected
     * 
     * @return true if it is connected; false otherwise
     */
    public boolean isConnected()
    {
        boolean connected = false;
        if (telnetClient != null)
        {
            connected = telnetClient.isConnected();
        }
        return connected;
    }

    /**
     *
     */
    public String waitFor(String[] waitForArray) throws IOException
    {
        InputStreamReader responseReader = null;
        StringBuffer answerFromRemoteHost = new StringBuffer();

        try
        {
            responseReader = new InputStreamReader(telnetClient.getInputStream());

            boolean found = false;

            do
            {
                char readChar = 0;
                long currentTime = System.currentTimeMillis();
                long timeoutTime = currentTime + timeout;

                while (readChar == 0)
                {
                    if (responseReader == null)
                    {
                        // responseReader can only be set to null if method
                        // releaseTelnetInputStreamReader()
                        // has been called, which should happen if host becomes
                        // unavailable.
                        throw new IOException(
                                "Telnet host is unavailable; stopped waiting for answer.");
                    }

                    if (responseReader.ready())
                    {
                        readChar = (char) responseReader.read();
                    }
                    else
                    {
                        try
                        {
                            Thread.sleep(50);
                        }
                        catch (InterruptedException e)
                        {
                            // Do nothing
                        }
                    }

                    currentTime = System.currentTimeMillis();

                    if ((!responseReader.ready()) && (currentTime > timeoutTime))
                    {
                        throw new IOException(
                                "A timeout has occured when trying to read the telnet stream");
                    }
                }

                answerFromRemoteHost.append(readChar);

                for (String aWaitFor : waitForArray)
                {
                    found = answerFromRemoteHost.toString().contains(aWaitFor);
                }

            }
            while (!found);
        }
        finally
        {
            if (responseReader != null)
            {
                responseReader.close();
            }
        }

        return answerFromRemoteHost.toString();
    }

    /**
     * Retrieves the input stream associated to this telnet connection
     */
    public InputStream getInputStream()
    {
        InputStream s = null;
        if (telnetClient != null)
        {
            s = telnetClient.getInputStream();
        }
        return s;
    }

    /**
     * Retrieves the output stream associated to this telnet connection
     */
    public OutputStream getOutputStream()
    {
        OutputStream s = null;
        if (telnetClient != null)
        {
            s = telnetClient.getOutputStream();
        }
        return s;
    }
}