Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 1 | /* |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 2 | * Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | * contributor license agreements. See the NOTICE file distributed with |
| 4 | * this work for additional information regarding copyright ownership. |
| 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | * (the "License"); you may not use this file except in compliance with |
| 7 | * the License. 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 | */ |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 17 | package org.apache.felix.shell.remote; |
| 18 | |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 19 | import java.io.BufferedReader; |
| 20 | import java.io.IOException; |
| 21 | import java.io.PrintStream; |
| 22 | import java.net.Socket; |
| 23 | |
Felix Meschberger | d7c324d | 2008-08-19 14:10:48 +0000 | [diff] [blame] | 24 | import org.apache.felix.shell.ShellService; |
| 25 | |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 26 | /** |
| 27 | * Implements the shell. |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 28 | * <p> |
| 29 | * This class is instantiated by the {@link Listener} thread to handle a single |
| 30 | * remote connection in its own thread. The connection handler thread either |
| 31 | * terminates on request by the remote end or by the Remote Shell bundle being |
| 32 | * stopped. In the latter case, the {@link #terminate()} method is called, which |
| 33 | * closes the Socket used to handle the remote console. This causes a |
| 34 | * <code>SocketException</code> in the handler thread reading from the socket |
| 35 | * which in turn causes the {@link #run()} method to terminate and thus to |
| 36 | * end the handler thread. |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 37 | */ |
| 38 | class Shell implements Runnable |
| 39 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 40 | private final Listener m_owner; |
| 41 | private final Socket m_socket; |
| 42 | private final AtomicInteger m_useCounter; |
| 43 | private volatile TerminalPrintStream m_out; |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 44 | |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 45 | public Shell(Listener owner, Socket s, AtomicInteger counter) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 46 | { |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 47 | m_owner = owner; |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 48 | m_socket = s; |
| 49 | m_useCounter = counter; |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 50 | }//constructor |
| 51 | |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 52 | void terminate() |
| 53 | { |
| 54 | // called by Listener.deactivate() to terminate this session |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 55 | exit("\r\nFelix Remote Shell Console Terminating"); |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 56 | }//terminate |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 57 | |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 58 | /** |
| 59 | * Runs the shell. |
| 60 | */ |
| 61 | public void run() |
| 62 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 63 | m_owner.registerConnection(this); |
| 64 | |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 65 | try |
| 66 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 67 | m_out = new TerminalPrintStream( |
| 68 | m_owner.getServices(), m_socket.getOutputStream()); |
| 69 | BufferedReader in = new BufferedReader( |
| 70 | new TerminalReader(m_socket.getInputStream(), m_out)); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 71 | ReentrantLock lock = new ReentrantLock(); |
| 72 | |
| 73 | // Print welcome banner. |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 74 | m_out.println(); |
| 75 | m_out.println("Felix Remote Shell Console:"); |
| 76 | m_out.println("============================"); |
| 77 | m_out.println(""); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 78 | |
| 79 | do |
| 80 | { |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 81 | String line = ""; |
| 82 | try |
| 83 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 84 | m_out.print("-> "); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 85 | line = in.readLine(); |
| 86 | //make sure to capture end of stream |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 87 | if (line == null) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 88 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 89 | m_out.println("exit"); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 90 | return; |
| 91 | } |
| 92 | } |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 93 | catch (Exception ex) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 94 | { |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 95 | return; |
| 96 | } |
| 97 | |
| 98 | line = line.trim(); |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 99 | if (line.equalsIgnoreCase("exit") || line.equalsIgnoreCase("disconnect")) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 100 | { |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 101 | return; |
| 102 | } |
| 103 | |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 104 | ShellService shs = m_owner.getServices().getFelixShellService(ServiceMediator.NO_WAIT); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 105 | try |
| 106 | { |
| 107 | lock.acquire(); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 108 | shs.executeCommand(line, m_out, m_out); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 109 | } |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 110 | catch (Exception ex) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 111 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 112 | m_owner.getServices().error("Shell::run()", ex); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 113 | } |
| 114 | finally |
| 115 | { |
| 116 | lock.release(); |
| 117 | } |
| 118 | } |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 119 | while (true); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 120 | } |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 121 | catch (IOException ex) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 122 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 123 | m_owner.getServices().error("Shell::run()", ex); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 124 | } |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 125 | finally |
| 126 | { |
| 127 | // no need to clean up in/out, since exit does it all |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 128 | exit(null); |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 129 | } |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 130 | }//run |
| 131 | |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 132 | private void exit(String message) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 133 | { |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 134 | // farewell message |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 135 | if (message != null) |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 136 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 137 | m_out.println(message); |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 138 | } |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 139 | m_out.println("Good Bye!"); |
| 140 | m_out.close(); |
Felix Meschberger | 73bf123 | 2009-02-02 08:28:42 +0000 | [diff] [blame] | 141 | |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 142 | try |
| 143 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 144 | m_socket.close(); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 145 | } |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 146 | catch (IOException ex) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 147 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 148 | m_owner.getServices().error("Shell::exit()", ex); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 149 | } |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 150 | m_owner.unregisterConnection(this); |
| 151 | m_useCounter.decrement(); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 152 | }//exit |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 153 | }//class Shell |