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 | d7c324d | 2008-08-19 14:10:48 +0000 | [diff] [blame] | 19 | import org.osgi.framework.BundleContext; |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 20 | import org.osgi.service.log.LogService; |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 21 | import org.osgi.util.tracker.ServiceTracker; |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 22 | |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 23 | /** |
| 24 | * Implements a mediator pattern class for services from the OSGi container. |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 25 | */ |
| 26 | class ServiceMediator |
| 27 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 28 | private final String m_bundleName; |
| 29 | private final long m_bundleId; |
| 30 | private final BundleContext m_context; |
| 31 | private final ServiceTracker m_logTracker; |
| 32 | private final ServiceTracker m_shellTracker; |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 33 | private final ServiceTracker m_cpTracker; |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 34 | |
| 35 | ServiceMediator(BundleContext context) |
| 36 | { |
| 37 | m_context = context; |
| 38 | m_bundleName = (m_context.getBundle().getSymbolicName() == null) |
| 39 | ? m_context.getBundle().getLocation() |
| 40 | : m_context.getBundle().getSymbolicName(); |
| 41 | m_bundleId = m_context.getBundle().getBundleId(); |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 42 | m_logTracker = new ServiceTracker( |
| 43 | m_context, "org.osgi.service.log.LogService", null); |
| 44 | m_logTracker.open(); |
| 45 | m_shellTracker = new ServiceTracker( |
| 46 | m_context, "org.apache.felix.shell.ShellService", null); |
| 47 | m_shellTracker.open(); |
| 48 | m_cpTracker = new ServiceTracker( |
| 49 | m_context, "org.apache.felix.service.command.CommandProcessor", null); |
| 50 | m_cpTracker.open(); |
| 51 | } |
| 52 | |
| 53 | public Object getCommandProcessor(long wait) |
| 54 | { |
| 55 | Object svcObj = null; |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 56 | try |
| 57 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 58 | if (wait < 0) |
| 59 | { |
| 60 | svcObj = m_cpTracker.getService(); |
| 61 | } |
| 62 | else |
| 63 | { |
| 64 | svcObj = m_cpTracker.waitForService(wait); |
| 65 | } |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 66 | } |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 67 | catch (InterruptedException e) |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 68 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 69 | e.printStackTrace(System.err); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 70 | } |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 71 | return svcObj; |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 72 | } |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 73 | |
| 74 | /** |
| 75 | * Returns a reference to the <tt>ShellService</tt> (Felix). |
| 76 | * |
| 77 | * @param wait time in milliseconds to wait for the reference if it isn't available. |
| 78 | * @return the reference to the <tt>ShellService</tt> as obtained from the OSGi service layer. |
| 79 | */ |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 80 | public Object getShellService(long wait) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 81 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 82 | Object svcObj = null; |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 83 | try |
| 84 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 85 | if (wait < 0) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 86 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 87 | svcObj = m_shellTracker.getService(); |
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 | else |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 90 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 91 | svcObj = m_shellTracker.waitForService(wait); |
| 92 | } |
| 93 | |
| 94 | return svcObj; |
| 95 | } |
| 96 | catch (InterruptedException e) |
| 97 | { |
| 98 | e.printStackTrace(System.err); |
| 99 | } |
| 100 | return svcObj; |
| 101 | }//getFelixShellService |
| 102 | |
| 103 | public Object getLogService(long wait) |
| 104 | { |
| 105 | Object svcObj = null; |
| 106 | try |
| 107 | { |
| 108 | if (wait < 0) |
| 109 | { |
| 110 | svcObj = m_logTracker.getService(); |
| 111 | } |
| 112 | else |
| 113 | { |
| 114 | svcObj = m_logTracker.waitForService(wait); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 115 | } |
| 116 | } |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 117 | catch (InterruptedException e) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 118 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 119 | e.printStackTrace(System.err); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 120 | } |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 121 | return svcObj; |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 122 | }//getLogService |
| 123 | |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 124 | public void info(String msg) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 125 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 126 | Object log = getLogService(NO_WAIT); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 127 | if (log != null) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 128 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 129 | ((LogService) log).log(LogService.LOG_INFO, msg); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 130 | } |
| 131 | else |
| 132 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 133 | sysout(msg); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 134 | } |
| 135 | }//info |
| 136 | |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 137 | public void error(String msg, Throwable t) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 138 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 139 | Object log = getLogService(NO_WAIT); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 140 | if (log != null) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 141 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 142 | ((LogService) log).log(LogService.LOG_ERROR, msg); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 143 | } |
| 144 | else |
| 145 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 146 | syserr(msg, t); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 147 | } |
| 148 | }//error |
| 149 | |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 150 | public void error(String msg) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 151 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 152 | Object log = getLogService(NO_WAIT); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 153 | if (log != null) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 154 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 155 | ((LogService) log).log(LogService.LOG_ERROR, msg); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 156 | } |
| 157 | else |
| 158 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 159 | syserr(msg, null); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 160 | } |
| 161 | }//error |
| 162 | |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 163 | public void debug(String msg) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 164 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 165 | Object log = getLogService(NO_WAIT); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 166 | if (log != null) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 167 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 168 | ((LogService) log).log(LogService.LOG_DEBUG, msg); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 169 | } |
| 170 | else |
| 171 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 172 | sysout(msg); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 173 | } |
| 174 | }//debug |
| 175 | |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 176 | public void warn(String msg) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 177 | { |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 178 | Object log = getLogService(NO_WAIT); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 179 | if (log != null) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 180 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 181 | ((LogService) log).log(LogService.LOG_WARNING, msg); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 182 | } |
| 183 | else |
| 184 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 185 | syserr(msg, null); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 186 | } |
| 187 | }//warn |
| 188 | |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 189 | private void sysout(String msg) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 190 | { |
| 191 | //Assemble String |
| 192 | StringBuffer sbuf = new StringBuffer(); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 193 | sbuf.append(m_bundleName); |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 194 | sbuf.append(" ["); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 195 | sbuf.append(m_bundleId); |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 196 | sbuf.append("] "); |
| 197 | sbuf.append(msg); |
| 198 | System.out.println(sbuf.toString()); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 199 | }//sysout |
| 200 | |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 201 | private void syserr(String msg, Throwable t) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 202 | { |
| 203 | //Assemble String |
| 204 | StringBuffer sbuf = new StringBuffer(); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 205 | sbuf.append(m_bundleName); |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 206 | sbuf.append(" ["); |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 207 | sbuf.append(m_bundleId); |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 208 | sbuf.append("] "); |
| 209 | sbuf.append(msg); |
| 210 | System.err.println(sbuf.toString()); |
| 211 | if (t != null) |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 212 | { |
Richard S. Hall | 59aef19 | 2009-04-25 14:50:37 +0000 | [diff] [blame] | 213 | t.printStackTrace(System.err); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 214 | } |
| 215 | }//logToSystem |
| 216 | |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 217 | /** |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 218 | * Deactivates this mediator, nulling out all references. |
| 219 | * If called when the bundle is stopped, the framework should actually take |
| 220 | * care of unregistering the <tt>ServiceListener</tt>. |
| 221 | */ |
| 222 | public void deactivate() |
| 223 | { |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 224 | if (m_logTracker != null) |
| 225 | { |
| 226 | m_logTracker.close(); |
| 227 | } |
| 228 | m_shellTracker.close(); |
Richard S. Hall | 6f5381e | 2010-08-17 14:49:44 +0000 | [diff] [blame] | 229 | m_cpTracker.close(); |
Felix Meschberger | efb2d08 | 2008-08-19 13:18:47 +0000 | [diff] [blame] | 230 | }//deactivate |
| 231 | |
Richard S. Hall | 55900ec | 2009-04-25 16:57:58 +0000 | [diff] [blame] | 232 | public static long WAIT_UNLIMITED = 0; |
| 233 | public static long NO_WAIT = -1; |
| 234 | }//class ServiceMediator |