Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | * or more contributor license agreements. See the NOTICE file |
| 4 | * distributed with this work for additional information |
| 5 | * regarding copyright ownership. The ASF 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 | */ |
Pierre De Rop | aacb3aa | 2009-12-04 22:53:23 +0000 | [diff] [blame] | 19 | package org.apache.felix.dm.impl.dependencies; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 20 | |
Marcel Offermans | 26081d3 | 2010-07-12 12:43:42 +0000 | [diff] [blame] | 21 | import java.lang.reflect.InvocationTargetException; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 22 | import java.lang.reflect.Proxy; |
| 23 | import java.util.AbstractMap; |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 24 | import java.util.ArrayList; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 25 | import java.util.Arrays; |
| 26 | import java.util.Comparator; |
Marcel Offermans | 117aa2f | 2009-12-10 09:48:17 +0000 | [diff] [blame] | 27 | import java.util.Dictionary; |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 28 | import java.util.HashMap; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 29 | import java.util.HashSet; |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 30 | import java.util.List; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 31 | import java.util.Map; |
Marcel Offermans | 26081d3 | 2010-07-12 12:43:42 +0000 | [diff] [blame] | 32 | import java.util.Properties; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 33 | import java.util.Set; |
| 34 | |
Marcel Offermans | 706fb27 | 2010-11-15 12:52:58 +0000 | [diff] [blame] | 35 | import org.apache.felix.dm.Component; |
Marcel Offermans | 9e50ef3 | 2010-10-07 11:37:00 +0000 | [diff] [blame] | 36 | import org.apache.felix.dm.ComponentDependencyDeclaration; |
Marcel Offermans | 8b93efa | 2010-07-02 18:27:21 +0000 | [diff] [blame] | 37 | import org.apache.felix.dm.Dependency; |
Marcel Offermans | 3d92121 | 2010-08-09 13:37:02 +0000 | [diff] [blame] | 38 | import org.apache.felix.dm.DependencyService; |
Marcel Offermans | 706fb27 | 2010-11-15 12:52:58 +0000 | [diff] [blame] | 39 | import org.apache.felix.dm.InvocationUtil; |
Marcel Offermans | 8b93efa | 2010-07-02 18:27:21 +0000 | [diff] [blame] | 40 | import org.apache.felix.dm.ServiceDependency; |
Pierre De Rop | aacb3aa | 2009-12-04 22:53:23 +0000 | [diff] [blame] | 41 | import org.apache.felix.dm.impl.DefaultNullObject; |
| 42 | import org.apache.felix.dm.impl.Logger; |
Marcel Offermans | faaed47 | 2010-09-08 10:07:32 +0000 | [diff] [blame] | 43 | import org.apache.felix.dm.tracker.ServiceTracker; |
| 44 | import org.apache.felix.dm.tracker.ServiceTrackerCustomizer; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 45 | import org.osgi.framework.BundleContext; |
| 46 | import org.osgi.framework.Constants; |
| 47 | import org.osgi.framework.InvalidSyntaxException; |
| 48 | import org.osgi.framework.ServiceReference; |
Marcel Offermans | 26081d3 | 2010-07-12 12:43:42 +0000 | [diff] [blame] | 49 | import org.osgi.service.log.LogService; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 50 | |
| 51 | /** |
| 52 | * Service dependency that can track an OSGi service. |
| 53 | * |
| 54 | * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a> |
| 55 | */ |
Marcel Offermans | faaed47 | 2010-09-08 10:07:32 +0000 | [diff] [blame] | 56 | public class ServiceDependencyImpl extends DependencyBase implements ServiceDependency, ServiceTrackerCustomizer, ComponentDependencyDeclaration { |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 57 | protected List m_services = new ArrayList(); |
Marcel Offermans | 74363c3 | 2009-11-23 19:56:08 +0000 | [diff] [blame] | 58 | protected volatile ServiceTracker m_tracker; |
| 59 | protected BundleContext m_context; |
Marcel Offermans | 74363c3 | 2009-11-23 19:56:08 +0000 | [diff] [blame] | 60 | protected volatile Class m_trackedServiceName; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 61 | private Object m_nullObject; |
| 62 | private volatile String m_trackedServiceFilter; |
| 63 | private volatile String m_trackedServiceFilterUnmodified; |
| 64 | private volatile ServiceReference m_trackedServiceReference; |
| 65 | private volatile boolean m_isStarted; |
| 66 | private Object m_callbackInstance; |
| 67 | private String m_callbackAdded; |
| 68 | private String m_callbackChanged; |
| 69 | private String m_callbackRemoved; |
| 70 | private boolean m_autoConfig; |
Marcel Offermans | 74363c3 | 2009-11-23 19:56:08 +0000 | [diff] [blame] | 71 | protected ServiceReference m_reference; |
| 72 | protected Object m_serviceInstance; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 73 | private String m_autoConfigInstance; |
| 74 | private boolean m_autoConfigInvoked; |
| 75 | private Object m_defaultImplementation; |
| 76 | private Object m_defaultImplementationInstance; |
Marcel Offermans | b196d72 | 2009-11-26 17:12:12 +0000 | [diff] [blame] | 77 | private boolean m_isAvailable; |
Marcel Offermans | 26081d3 | 2010-07-12 12:43:42 +0000 | [diff] [blame] | 78 | private boolean m_propagate; |
| 79 | private Object m_propagateCallbackInstance; |
| 80 | private String m_propagateCallbackMethod; |
Marcel Offermans | 7784e40 | 2011-01-21 20:41:50 +0000 | [diff] [blame^] | 81 | private final Map m_sr = new HashMap(); /* <DependencyService, Set<Tuple<ServiceReference, Object>> */ |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 82 | |
| 83 | private static final Comparator COMPARATOR = new Comparator() { |
| 84 | public int getRank(ServiceReference ref) { |
| 85 | Object ranking = ref.getProperty(Constants.SERVICE_RANKING); |
| 86 | if (ranking != null && (ranking instanceof Integer)) { |
| 87 | return ((Integer) ranking).intValue(); |
| 88 | } |
| 89 | return 0; |
| 90 | } |
| 91 | |
| 92 | public int compare(Object a, Object b) { |
| 93 | ServiceReference ra = (ServiceReference) a, rb = (ServiceReference) b; |
| 94 | int ranka = getRank(ra); |
| 95 | int rankb = getRank(rb); |
| 96 | if (ranka < rankb) { |
| 97 | return -1; |
| 98 | } |
| 99 | else if (ranka > rankb) { |
| 100 | return 1; |
| 101 | } |
| 102 | return 0; |
| 103 | } |
| 104 | }; |
| 105 | |
Marcel Offermans | 7784e40 | 2011-01-21 20:41:50 +0000 | [diff] [blame^] | 106 | private static final class Tuple /* <ServiceReference, Object> */ { |
| 107 | private final ServiceReference m_serviceReference; |
| 108 | private final Object m_service; |
| 109 | |
| 110 | public Tuple(ServiceReference first, Object last) { |
| 111 | m_serviceReference = first; |
| 112 | m_service = last; |
| 113 | } |
| 114 | |
| 115 | public ServiceReference getServiceReference() { |
| 116 | return m_serviceReference; |
| 117 | } |
| 118 | |
| 119 | public Object getService() { |
| 120 | return m_service; |
| 121 | } |
| 122 | |
| 123 | public boolean equals(Object obj) { |
| 124 | return ((Tuple) obj).getServiceReference().equals(getServiceReference()); |
| 125 | } |
| 126 | |
| 127 | public int hashCode() { |
| 128 | return m_serviceReference.hashCode(); |
| 129 | } |
| 130 | } |
| 131 | |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 132 | /** |
| 133 | * Entry to wrap service properties behind a Map. |
| 134 | */ |
Marcel Offermans | 7784e40 | 2011-01-21 20:41:50 +0000 | [diff] [blame^] | 135 | private static final class ServicePropertiesMapEntry implements Map.Entry { |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 136 | private final String m_key; |
| 137 | private Object m_value; |
| 138 | |
| 139 | public ServicePropertiesMapEntry(String key, Object value) { |
| 140 | m_key = key; |
| 141 | m_value = value; |
| 142 | } |
| 143 | |
| 144 | public Object getKey() { |
| 145 | return m_key; |
| 146 | } |
| 147 | |
| 148 | public Object getValue() { |
| 149 | return m_value; |
| 150 | } |
| 151 | |
| 152 | public String toString() { |
| 153 | return m_key + "=" + m_value; |
| 154 | } |
| 155 | |
| 156 | public Object setValue(Object value) { |
| 157 | Object oldValue = m_value; |
| 158 | m_value = value; |
| 159 | return oldValue; |
| 160 | } |
| 161 | |
| 162 | public boolean equals(Object o) { |
| 163 | if (!(o instanceof Map.Entry)) { |
| 164 | return false; |
| 165 | } |
| 166 | Map.Entry e = (Map.Entry) o; |
| 167 | return eq(m_key, e.getKey()) && eq(m_value, e.getValue()); |
| 168 | } |
| 169 | |
| 170 | public int hashCode() { |
| 171 | return ((m_key == null) ? 0 : m_key.hashCode()) ^ ((m_value == null) ? 0 : m_value.hashCode()); |
| 172 | } |
| 173 | |
| 174 | private static final boolean eq(Object o1, Object o2) { |
| 175 | return (o1 == null ? o2 == null : o1.equals(o2)); |
| 176 | } |
| 177 | } |
| 178 | |
| 179 | /** |
| 180 | * Wraps service properties behind a Map. |
| 181 | */ |
| 182 | private final static class ServicePropertiesMap extends AbstractMap { |
| 183 | private final ServiceReference m_ref; |
| 184 | |
| 185 | public ServicePropertiesMap(ServiceReference ref) { |
| 186 | m_ref = ref; |
| 187 | } |
| 188 | |
| 189 | public Object get(Object key) { |
| 190 | return m_ref.getProperty(key.toString()); |
| 191 | } |
| 192 | |
| 193 | public int size() { |
| 194 | return m_ref.getPropertyKeys().length; |
| 195 | } |
| 196 | |
| 197 | public Set entrySet() { |
| 198 | Set set = new HashSet(); |
| 199 | String[] keys = m_ref.getPropertyKeys(); |
| 200 | for (int i = 0; i < keys.length; i++) { |
| 201 | set.add(new ServicePropertiesMapEntry(keys[i], m_ref.getProperty(keys[i]))); |
| 202 | } |
| 203 | return set; |
| 204 | } |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Creates a new service dependency. |
| 209 | * |
| 210 | * @param context the bundle context |
| 211 | * @param logger the logger |
| 212 | */ |
Pierre De Rop | aacb3aa | 2009-12-04 22:53:23 +0000 | [diff] [blame] | 213 | public ServiceDependencyImpl(BundleContext context, Logger logger) { |
Marcel Offermans | b196d72 | 2009-11-26 17:12:12 +0000 | [diff] [blame] | 214 | super(logger); |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 215 | m_context = context; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 216 | m_autoConfig = true; |
| 217 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 218 | |
Marcel Offermans | b1959f4 | 2010-07-01 12:23:51 +0000 | [diff] [blame] | 219 | /** Copying constructor that clones an existing instance. */ |
| 220 | public ServiceDependencyImpl(ServiceDependencyImpl prototype) { |
| 221 | super(prototype); |
Marcel Offermans | e7baff5 | 2010-12-17 08:51:52 +0000 | [diff] [blame] | 222 | synchronized (prototype) { |
| 223 | m_context = prototype.m_context; |
| 224 | m_autoConfig = prototype.m_autoConfig; |
| 225 | m_trackedServiceName = prototype.m_trackedServiceName; |
| 226 | m_nullObject = prototype.m_nullObject; |
| 227 | m_trackedServiceFilter = prototype.m_trackedServiceFilter; |
| 228 | m_trackedServiceFilterUnmodified = prototype.m_trackedServiceFilterUnmodified; |
| 229 | m_trackedServiceReference = prototype.m_trackedServiceReference; |
| 230 | m_callbackInstance = prototype.m_callbackInstance; |
| 231 | m_callbackAdded = prototype.m_callbackAdded; |
| 232 | m_callbackChanged = prototype.m_callbackChanged; |
| 233 | m_callbackRemoved = prototype.m_callbackRemoved; |
| 234 | m_autoConfigInstance = prototype.m_autoConfigInstance; |
| 235 | m_defaultImplementation = prototype.m_defaultImplementation; |
| 236 | } |
Marcel Offermans | b1959f4 | 2010-07-01 12:23:51 +0000 | [diff] [blame] | 237 | } |
| 238 | |
| 239 | public Dependency createCopy() { |
| 240 | return new ServiceDependencyImpl(this); |
| 241 | } |
| 242 | |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 243 | public synchronized boolean isAutoConfig() { |
| 244 | return m_autoConfig; |
| 245 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 246 | |
Marcel Offermans | b196d72 | 2009-11-26 17:12:12 +0000 | [diff] [blame] | 247 | public synchronized boolean isAvailable() { |
| 248 | return m_isAvailable; |
| 249 | } |
| 250 | |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 251 | public synchronized Object getService() { |
| 252 | Object service = null; |
| 253 | if (m_isStarted) { |
| 254 | service = m_tracker.getService(); |
| 255 | } |
Marcel Offermans | 001db05 | 2009-12-08 08:58:40 +0000 | [diff] [blame] | 256 | if (service == null && isAutoConfig()) { |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 257 | service = getDefaultImplementation(); |
| 258 | if (service == null) { |
| 259 | service = getNullObject(); |
| 260 | } |
| 261 | } |
| 262 | return service; |
| 263 | } |
| 264 | |
| 265 | public Object lookupService() { |
| 266 | Object service = null; |
| 267 | if (m_isStarted) { |
Marcel Offermans | 001db05 | 2009-12-08 08:58:40 +0000 | [diff] [blame] | 268 | service = getService(); |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 269 | } |
| 270 | else { |
| 271 | ServiceReference[] refs = null; |
| 272 | ServiceReference ref = null; |
| 273 | if (m_trackedServiceName != null) { |
| 274 | if (m_trackedServiceFilter != null) { |
| 275 | try { |
| 276 | refs = m_context.getServiceReferences(m_trackedServiceName.getName(), m_trackedServiceFilter); |
| 277 | if (refs != null) { |
| 278 | Arrays.sort(refs, COMPARATOR); |
| 279 | ref = refs[0]; |
| 280 | } |
| 281 | } |
| 282 | catch (InvalidSyntaxException e) { |
| 283 | throw new IllegalStateException("Invalid filter definition for dependency."); |
| 284 | } |
| 285 | } |
| 286 | else if (m_trackedServiceReference != null) { |
| 287 | ref = m_trackedServiceReference; |
| 288 | } |
| 289 | else { |
| 290 | ref = m_context.getServiceReference(m_trackedServiceName.getName()); |
| 291 | } |
| 292 | if (ref != null) { |
| 293 | service = m_context.getService(ref); |
| 294 | } |
| 295 | } |
| 296 | else { |
| 297 | throw new IllegalStateException("Could not lookup dependency, no service name specified."); |
| 298 | } |
| 299 | } |
Marcel Offermans | 001db05 | 2009-12-08 08:58:40 +0000 | [diff] [blame] | 300 | if (service == null && isAutoConfig()) { |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 301 | service = getDefaultImplementation(); |
| 302 | if (service == null) { |
| 303 | service = getNullObject(); |
| 304 | } |
| 305 | } |
| 306 | return service; |
| 307 | } |
Marcel Offermans | b1959f4 | 2010-07-01 12:23:51 +0000 | [diff] [blame] | 308 | |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 309 | // TODO lots of duplication in lookupService() |
| 310 | public ServiceReference lookupServiceReference() { |
| 311 | ServiceReference service = null; |
| 312 | if (m_isStarted) { |
| 313 | service = m_tracker.getServiceReference(); |
| 314 | } |
| 315 | else { |
| 316 | ServiceReference[] refs = null; |
| 317 | ServiceReference ref = null; |
| 318 | if (m_trackedServiceName != null) { |
| 319 | if (m_trackedServiceFilter != null) { |
| 320 | try { |
| 321 | refs = m_context.getServiceReferences(m_trackedServiceName.getName(), m_trackedServiceFilter); |
| 322 | if (refs != null) { |
| 323 | Arrays.sort(refs, COMPARATOR); |
| 324 | ref = refs[0]; |
| 325 | } |
| 326 | } |
| 327 | catch (InvalidSyntaxException e) { |
| 328 | throw new IllegalStateException("Invalid filter definition for dependency."); |
| 329 | } |
| 330 | } |
| 331 | else if (m_trackedServiceReference != null) { |
| 332 | ref = m_trackedServiceReference; |
| 333 | } |
| 334 | else { |
| 335 | ref = m_context.getServiceReference(m_trackedServiceName.getName()); |
| 336 | } |
| 337 | if (ref != null) { |
| 338 | service = ref; |
| 339 | } |
| 340 | } |
| 341 | else { |
| 342 | throw new IllegalStateException("Could not lookup dependency, no service name specified."); |
| 343 | } |
| 344 | } |
| 345 | return service; |
| 346 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 347 | |
| 348 | private Object getNullObject() { |
| 349 | if (m_nullObject == null) { |
| 350 | Class trackedServiceName; |
| 351 | synchronized (this) { |
| 352 | trackedServiceName = m_trackedServiceName; |
| 353 | } |
| 354 | try { |
| 355 | m_nullObject = Proxy.newProxyInstance(trackedServiceName.getClassLoader(), new Class[] {trackedServiceName}, new DefaultNullObject()); |
| 356 | } |
| 357 | catch (Exception e) { |
| 358 | m_logger.log(Logger.LOG_ERROR, "Could not create null object for " + trackedServiceName + ".", e); |
| 359 | } |
| 360 | } |
| 361 | return m_nullObject; |
| 362 | } |
| 363 | |
| 364 | private Object getDefaultImplementation() { |
| 365 | if (m_defaultImplementation != null) { |
| 366 | if (m_defaultImplementation instanceof Class) { |
| 367 | try { |
| 368 | m_defaultImplementationInstance = ((Class) m_defaultImplementation).newInstance(); |
| 369 | } |
| 370 | catch (Exception e) { |
| 371 | m_logger.log(Logger.LOG_ERROR, "Could not create default implementation instance of class " + m_defaultImplementation + ".", e); |
| 372 | } |
| 373 | } |
| 374 | else { |
| 375 | m_defaultImplementationInstance = m_defaultImplementation; |
| 376 | } |
| 377 | } |
| 378 | return m_defaultImplementationInstance; |
| 379 | } |
| 380 | |
| 381 | public synchronized Class getInterface() { |
| 382 | return m_trackedServiceName; |
| 383 | } |
| 384 | |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 385 | public void start(DependencyService service) { |
| 386 | boolean needsStarting = false; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 387 | synchronized (this) { |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 388 | m_services.add(service); |
| 389 | if (!m_isStarted) { |
| 390 | if (m_trackedServiceName != null) { |
| 391 | if (m_trackedServiceFilter != null) { |
| 392 | try { |
| 393 | m_tracker = new ServiceTracker(m_context, m_context.createFilter(m_trackedServiceFilter), this); |
| 394 | } |
| 395 | catch (InvalidSyntaxException e) { |
Marcel Offermans | ad76067 | 2010-03-03 15:30:01 +0000 | [diff] [blame] | 396 | throw new IllegalStateException("Invalid filter definition for dependency: " + m_trackedServiceFilter); |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 397 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 398 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 399 | else if (m_trackedServiceReference != null) { |
| 400 | m_tracker = new ServiceTracker(m_context, m_trackedServiceReference, this); |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 401 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 402 | else { |
| 403 | m_tracker = new ServiceTracker(m_context, m_trackedServiceName.getName(), this); |
| 404 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 405 | } |
| 406 | else { |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 407 | throw new IllegalStateException("Could not create tracker for dependency, no service name specified."); |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 408 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 409 | m_isStarted = true; |
| 410 | needsStarting = true; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 411 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 412 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 413 | if (needsStarting) { |
| 414 | m_tracker.open(); |
| 415 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 416 | } |
| 417 | |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 418 | public void stop(DependencyService service) { |
| 419 | boolean needsStopping = false; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 420 | synchronized (this) { |
Marcel Offermans | cae6136 | 2009-12-01 08:37:10 +0000 | [diff] [blame] | 421 | if (m_services.size() == 1 && m_services.contains(service)) { |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 422 | m_isStarted = false; |
| 423 | needsStopping = true; |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 424 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 425 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 426 | if (needsStopping) { |
| 427 | m_tracker.close(); |
| 428 | m_tracker = null; |
| 429 | } |
Marcel Offermans | 1c944ec | 2010-10-11 13:55:02 +0000 | [diff] [blame] | 430 | //moved this down |
| 431 | synchronized (this) { |
| 432 | m_services.remove(service); |
| 433 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 434 | } |
| 435 | |
| 436 | public Object addingService(ServiceReference ref) { |
| 437 | Object service = m_context.getService(ref); |
| 438 | // first check to make sure the service is actually an instance of our service |
| 439 | if (!m_trackedServiceName.isInstance(service)) { |
| 440 | return null; |
| 441 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 442 | return service; |
| 443 | } |
| 444 | |
| 445 | public void addedService(ServiceReference ref, Object service) { |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 446 | boolean makeAvailable = makeAvailable(); |
| 447 | |
Marcel Offermans | 203bdad | 2009-12-04 09:23:04 +0000 | [diff] [blame] | 448 | Object[] services; |
| 449 | synchronized (this) { |
| 450 | services = m_services.toArray(); |
| 451 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 452 | for (int i = 0; i < services.length; i++) { |
| 453 | DependencyService ds = (DependencyService) services[i]; |
| 454 | if (makeAvailable) { |
Marcel Offermans | fea1484 | 2010-10-14 14:45:36 +0000 | [diff] [blame] | 455 | if (ds.isInstantiated() && isInstanceBound() && isRequired()) { |
| 456 | invokeAdded(ds, ref, service); |
| 457 | } |
Pierre De Rop | 1785c33 | 2010-06-11 06:03:53 +0000 | [diff] [blame] | 458 | // The dependency callback will be defered until all required dependency are available. |
| 459 | ds.dependencyAvailable(this); |
| 460 | if (!isRequired()) { |
| 461 | // For optional dependency, we always invoke callback, because at this point, we know |
| 462 | // that the service has been started, and the service start method has been called. |
| 463 | // (See the ServiceImpl.bindService method, which will activate optional dependencies using |
| 464 | // startTrackingOptional() method). |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 465 | invokeAdded(ds, ref, service); |
| 466 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 467 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 468 | else { |
| 469 | ds.dependencyChanged(this); |
Pierre De Rop | 1785c33 | 2010-06-11 06:03:53 +0000 | [diff] [blame] | 470 | // At this point, either the dependency is optional (meaning that the service has been started, |
| 471 | // because if not, then our dependency would not be active); or the dependency is required, |
| 472 | // meaning that either the service is not yet started, or already started. |
| 473 | // In all cases, we have to inject the required dependency. |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 474 | |
| 475 | // we only try to invoke the method here if we are really already instantiated |
| 476 | if (ds.isInstantiated() && ds.getCompositionInstances().length > 0) { |
| 477 | invokeAdded(ds, ref, service); |
| 478 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 479 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 480 | } |
| 481 | } |
| 482 | |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 483 | public void modifiedService(ServiceReference ref, Object service) { |
Marcel Offermans | 203bdad | 2009-12-04 09:23:04 +0000 | [diff] [blame] | 484 | Object[] services; |
| 485 | synchronized (this) { |
| 486 | services = m_services.toArray(); |
| 487 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 488 | for (int i = 0; i < services.length; i++) { |
| 489 | DependencyService ds = (DependencyService) services[i]; |
| 490 | ds.dependencyChanged(this); |
| 491 | if (ds.isRegistered()) { |
| 492 | invokeChanged(ds, ref, service); |
| 493 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 494 | } |
| 495 | } |
| 496 | |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 497 | public void removedService(ServiceReference ref, Object service) { |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 498 | boolean makeUnavailable = makeUnavailable(); |
| 499 | |
Marcel Offermans | 203bdad | 2009-12-04 09:23:04 +0000 | [diff] [blame] | 500 | Object[] services; |
| 501 | synchronized (this) { |
| 502 | services = m_services.toArray(); |
| 503 | } |
Marcel Offermans | 1c944ec | 2010-10-11 13:55:02 +0000 | [diff] [blame] | 504 | |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 505 | for (int i = 0; i < services.length; i++) { |
| 506 | DependencyService ds = (DependencyService) services[i]; |
| 507 | if (makeUnavailable) { |
| 508 | ds.dependencyUnavailable(this); |
Marcel Offermans | fea1484 | 2010-10-14 14:45:36 +0000 | [diff] [blame] | 509 | if (!isRequired() || (ds.isInstantiated() && isInstanceBound())) { |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 510 | invokeRemoved(ds, ref, service); |
| 511 | } |
| 512 | } |
| 513 | else { |
| 514 | ds.dependencyChanged(this); |
| 515 | invokeRemoved(ds, ref, service); |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 516 | } |
| 517 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 518 | // unget what we got in addingService (see ServiceTracker 701.4.1) |
| 519 | m_context.ungetService(ref); |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 520 | |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 521 | } |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 522 | |
Marcel Offermans | ea89b86 | 2010-06-24 13:14:43 +0000 | [diff] [blame] | 523 | public void invokeAdded(DependencyService dependencyService, ServiceReference reference, Object service) { |
Marcel Offermans | e7baff5 | 2010-12-17 08:51:52 +0000 | [diff] [blame] | 524 | boolean added = false; |
| 525 | synchronized (m_sr) { |
| 526 | Set set = (Set) m_sr.get(dependencyService); |
| 527 | if (set == null) { |
| 528 | set = new HashSet(); |
| 529 | m_sr.put(dependencyService, set); |
| 530 | } |
Marcel Offermans | 7784e40 | 2011-01-21 20:41:50 +0000 | [diff] [blame^] | 531 | added = set.add(new Tuple(reference, service)); |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 532 | } |
Marcel Offermans | e7baff5 | 2010-12-17 08:51:52 +0000 | [diff] [blame] | 533 | if (added) { |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 534 | invoke(dependencyService, reference, service, m_callbackAdded); |
| 535 | } |
Marcel Offermans | ea89b86 | 2010-06-24 13:14:43 +0000 | [diff] [blame] | 536 | } |
| 537 | |
| 538 | public void invokeChanged(DependencyService dependencyService, ServiceReference reference, Object service) { |
| 539 | invoke(dependencyService, reference, service, m_callbackChanged); |
| 540 | } |
| 541 | |
Marcel Offermans | b196d72 | 2009-11-26 17:12:12 +0000 | [diff] [blame] | 542 | public void invokeRemoved(DependencyService dependencyService, ServiceReference reference, Object service) { |
Marcel Offermans | e7baff5 | 2010-12-17 08:51:52 +0000 | [diff] [blame] | 543 | boolean removed = false; |
| 544 | synchronized (m_sr) { |
| 545 | Set set = (Set) m_sr.get(dependencyService); |
Marcel Offermans | 7784e40 | 2011-01-21 20:41:50 +0000 | [diff] [blame^] | 546 | removed = (set != null && set.remove(new Tuple(reference, service))); |
Marcel Offermans | e7baff5 | 2010-12-17 08:51:52 +0000 | [diff] [blame] | 547 | } |
| 548 | if (removed) { |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 549 | invoke(dependencyService, reference, service, m_callbackRemoved); |
| 550 | } |
Marcel Offermans | ea89b86 | 2010-06-24 13:14:43 +0000 | [diff] [blame] | 551 | } |
| 552 | |
| 553 | public void invoke(DependencyService dependencyService, ServiceReference reference, Object service, String name) { |
| 554 | if (name != null) { |
| 555 | dependencyService.invokeCallbackMethod(getCallbackInstances(dependencyService), name, |
Marcel Offermans | 706fb27 | 2010-11-15 12:52:58 +0000 | [diff] [blame] | 556 | new Class[][] { |
| 557 | {Component.class, ServiceReference.class, m_trackedServiceName}, {Component.class, ServiceReference.class, Object.class}, {Component.class, ServiceReference.class}, {Component.class, m_trackedServiceName}, {Component.class, Object.class}, {Component.class}, {Component.class, Map.class, m_trackedServiceName}, |
| 558 | {ServiceReference.class, m_trackedServiceName}, {ServiceReference.class, Object.class}, {ServiceReference.class}, {m_trackedServiceName}, {Object.class}, {}, {Map.class, m_trackedServiceName} |
| 559 | }, |
| 560 | new Object[][] { |
| 561 | {dependencyService, reference, service}, {dependencyService, reference, service}, {dependencyService, reference}, {dependencyService, service}, {dependencyService, service}, {dependencyService}, {dependencyService, new ServicePropertiesMap(reference), service}, |
| 562 | {reference, service}, {reference, service}, {reference}, {service}, {service}, {}, {new ServicePropertiesMap(reference), service} |
| 563 | } |
Marcel Offermans | b196d72 | 2009-11-26 17:12:12 +0000 | [diff] [blame] | 564 | ); |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 565 | } |
| 566 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 567 | |
Marcel Offermans | 74363c3 | 2009-11-23 19:56:08 +0000 | [diff] [blame] | 568 | protected synchronized boolean makeAvailable() { |
Marcel Offermans | b196d72 | 2009-11-26 17:12:12 +0000 | [diff] [blame] | 569 | if (!isAvailable()) { |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 570 | m_isAvailable = true; |
| 571 | return true; |
| 572 | } |
| 573 | return false; |
| 574 | } |
| 575 | |
| 576 | private synchronized boolean makeUnavailable() { |
Marcel Offermans | b196d72 | 2009-11-26 17:12:12 +0000 | [diff] [blame] | 577 | if ((isAvailable()) && (m_tracker.getServiceReference() == null)) { |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 578 | m_isAvailable = false; |
| 579 | return true; |
| 580 | } |
| 581 | return false; |
| 582 | } |
| 583 | |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 584 | private synchronized Object[] getCallbackInstances(DependencyService dependencyService) { |
| 585 | if (m_callbackInstance == null) { |
| 586 | return dependencyService.getCompositionInstances(); |
| 587 | } |
| 588 | else { |
| 589 | return new Object[] { m_callbackInstance }; |
| 590 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 591 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 592 | |
| 593 | // ----- CREATION |
| 594 | |
| 595 | /** |
| 596 | * Sets the name of the service that should be tracked. |
| 597 | * |
| 598 | * @param serviceName the name of the service |
| 599 | * @return this service dependency |
| 600 | */ |
| 601 | public synchronized ServiceDependency setService(Class serviceName) { |
| 602 | ensureNotActive(); |
| 603 | if (serviceName == null) { |
| 604 | throw new IllegalArgumentException("Service name cannot be null."); |
| 605 | } |
| 606 | m_trackedServiceName = serviceName; |
| 607 | m_trackedServiceReference = null; |
| 608 | m_trackedServiceFilter = null; |
| 609 | return this; |
| 610 | } |
| 611 | |
| 612 | /** |
| 613 | * Sets the name of the service that should be tracked. You can either specify |
| 614 | * only the name, or the name and a filter. In the latter case, the filter is used |
| 615 | * to track the service and should only return services of the type that was specified |
| 616 | * in the name. To make sure of this, the filter is actually extended internally to |
| 617 | * filter on the correct name. |
| 618 | * |
| 619 | * @param serviceName the name of the service |
| 620 | * @param serviceFilter the filter condition |
| 621 | * @return this service dependency |
| 622 | */ |
| 623 | public synchronized ServiceDependency setService(Class serviceName, String serviceFilter) { |
| 624 | ensureNotActive(); |
| 625 | if (serviceName == null) { |
| 626 | throw new IllegalArgumentException("Service name cannot be null."); |
| 627 | } |
| 628 | m_trackedServiceName = serviceName; |
| 629 | if (serviceFilter != null) { |
| 630 | m_trackedServiceFilterUnmodified = serviceFilter; |
| 631 | m_trackedServiceFilter ="(&(" + Constants.OBJECTCLASS + "=" + serviceName.getName() + ")" + serviceFilter + ")"; |
| 632 | } |
| 633 | else { |
| 634 | m_trackedServiceFilterUnmodified = null; |
| 635 | m_trackedServiceFilter = null; |
| 636 | } |
| 637 | m_trackedServiceReference = null; |
| 638 | return this; |
| 639 | } |
Marcel Offermans | a83c25a | 2009-12-22 13:38:38 +0000 | [diff] [blame] | 640 | |
| 641 | public synchronized ServiceDependency setService(String serviceFilter) { |
| 642 | ensureNotActive(); |
| 643 | if (serviceFilter == null) { |
| 644 | throw new IllegalArgumentException("Service filter cannot be null."); |
| 645 | } |
| 646 | m_trackedServiceName = Object.class; |
| 647 | if (serviceFilter != null) { |
| 648 | m_trackedServiceFilterUnmodified = serviceFilter; |
| 649 | m_trackedServiceFilter = serviceFilter; |
| 650 | } |
| 651 | m_trackedServiceReference = null; |
| 652 | return this; |
| 653 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 654 | |
| 655 | /** |
| 656 | * Sets the name of the service that should be tracked. You can either specify |
| 657 | * only the name, or the name and a reference. In the latter case, the service reference |
| 658 | * is used to track the service and should only return services of the type that was |
| 659 | * specified in the name. |
| 660 | * |
| 661 | * @param serviceName the name of the service |
| 662 | * @param serviceReference the service reference to track |
| 663 | * @return this service dependency |
| 664 | */ |
| 665 | public synchronized ServiceDependency setService(Class serviceName, ServiceReference serviceReference) { |
| 666 | ensureNotActive(); |
| 667 | if (serviceName == null) { |
| 668 | throw new IllegalArgumentException("Service name cannot be null."); |
| 669 | } |
| 670 | m_trackedServiceName = serviceName; |
| 671 | m_trackedServiceReference = serviceReference; |
| 672 | m_trackedServiceFilterUnmodified = null; |
| 673 | m_trackedServiceFilter = null; |
| 674 | return this; |
| 675 | } |
| 676 | |
| 677 | /** |
| 678 | * Sets the default implementation for this service dependency. You can use this to supply |
| 679 | * your own implementation that will be used instead of a Null Object when the dependency is |
| 680 | * not available. This is also convenient if the service dependency is not an interface |
| 681 | * (which would cause the Null Object creation to fail) but a class. |
| 682 | * |
| 683 | * @param implementation the instance to use or the class to instantiate if you want to lazily |
| 684 | * instantiate this implementation |
| 685 | * @return this service dependency |
| 686 | */ |
| 687 | public synchronized ServiceDependency setDefaultImplementation(Object implementation) { |
| 688 | ensureNotActive(); |
| 689 | m_defaultImplementation = implementation; |
| 690 | return this; |
| 691 | } |
| 692 | |
| 693 | /** |
| 694 | * Sets the required flag which determines if this service is required or not. |
| 695 | * |
| 696 | * @param required the required flag |
| 697 | * @return this service dependency |
| 698 | */ |
| 699 | public synchronized ServiceDependency setRequired(boolean required) { |
| 700 | ensureNotActive(); |
Marcel Offermans | b196d72 | 2009-11-26 17:12:12 +0000 | [diff] [blame] | 701 | setIsRequired(required); |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 702 | return this; |
| 703 | } |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 704 | |
| 705 | public ServiceDependency setInstanceBound(boolean isInstanceBound) { |
Marcel Offermans | 61a8114 | 2010-04-02 15:16:50 +0000 | [diff] [blame] | 706 | setIsInstanceBound(isInstanceBound); |
Marcel Offermans | e14b342 | 2009-11-25 23:04:32 +0000 | [diff] [blame] | 707 | return this; |
| 708 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 709 | |
| 710 | /** |
| 711 | * Sets auto configuration for this service. Auto configuration allows the |
| 712 | * dependency to fill in any attributes in the service implementation that |
| 713 | * are of the same type as this dependency. Default is on. |
| 714 | * |
| 715 | * @param autoConfig the value of auto config |
| 716 | * @return this service dependency |
| 717 | */ |
| 718 | public synchronized ServiceDependency setAutoConfig(boolean autoConfig) { |
| 719 | ensureNotActive(); |
| 720 | m_autoConfig = autoConfig; |
| 721 | m_autoConfigInvoked = true; |
| 722 | return this; |
| 723 | } |
| 724 | |
| 725 | /** |
| 726 | * Sets auto configuration for this service. Auto configuration allows the |
| 727 | * dependency to fill in the attribute in the service implementation that |
| 728 | * has the same type and instance name. |
| 729 | * |
| 730 | * @param instanceName the name of attribute to auto config |
| 731 | * @return this service dependency |
| 732 | */ |
| 733 | public synchronized ServiceDependency setAutoConfig(String instanceName) { |
| 734 | ensureNotActive(); |
| 735 | m_autoConfig = (instanceName != null); |
| 736 | m_autoConfigInstance = instanceName; |
| 737 | m_autoConfigInvoked = true; |
| 738 | return this; |
| 739 | } |
| 740 | |
| 741 | /** |
| 742 | * Sets the callbacks for this service. These callbacks can be used as hooks whenever a |
| 743 | * dependency is added or removed. When you specify callbacks, the auto configuration |
| 744 | * feature is automatically turned off, because we're assuming you don't need it in this |
| 745 | * case. |
| 746 | * |
| 747 | * @param added the method to call when a service was added |
| 748 | * @param removed the method to call when a service was removed |
| 749 | * @return this service dependency |
| 750 | */ |
| 751 | public synchronized ServiceDependency setCallbacks(String added, String removed) { |
| 752 | return setCallbacks(null, added, null, removed); |
| 753 | } |
| 754 | |
| 755 | /** |
| 756 | * Sets the callbacks for this service. These callbacks can be used as hooks whenever a |
| 757 | * dependency is added, changed or removed. When you specify callbacks, the auto |
| 758 | * configuration feature is automatically turned off, because we're assuming you don't |
| 759 | * need it in this case. |
| 760 | * |
| 761 | * @param added the method to call when a service was added |
| 762 | * @param changed the method to call when a service was changed |
| 763 | * @param removed the method to call when a service was removed |
| 764 | * @return this service dependency |
| 765 | */ |
| 766 | public synchronized ServiceDependency setCallbacks(String added, String changed, String removed) { |
| 767 | return setCallbacks(null, added, changed, removed); |
| 768 | } |
| 769 | |
| 770 | /** |
| 771 | * Sets the callbacks for this service. These callbacks can be used as hooks whenever a |
| 772 | * dependency is added or removed. They are called on the instance you provide. When you |
| 773 | * specify callbacks, the auto configuration feature is automatically turned off, because |
| 774 | * we're assuming you don't need it in this case. |
| 775 | * |
| 776 | * @param instance the instance to call the callbacks on |
| 777 | * @param added the method to call when a service was added |
| 778 | * @param removed the method to call when a service was removed |
| 779 | * @return this service dependency |
| 780 | */ |
| 781 | public synchronized ServiceDependency setCallbacks(Object instance, String added, String removed) { |
| 782 | return setCallbacks(instance, added, null, removed); |
| 783 | } |
| 784 | |
| 785 | /** |
| 786 | * Sets the callbacks for this service. These callbacks can be used as hooks whenever a |
| 787 | * dependency is added, changed or removed. They are called on the instance you provide. When you |
| 788 | * specify callbacks, the auto configuration feature is automatically turned off, because |
| 789 | * we're assuming you don't need it in this case. |
| 790 | * |
| 791 | * @param instance the instance to call the callbacks on |
| 792 | * @param added the method to call when a service was added |
| 793 | * @param changed the method to call when a service was changed |
| 794 | * @param removed the method to call when a service was removed |
| 795 | * @return this service dependency |
| 796 | */ |
| 797 | public synchronized ServiceDependency setCallbacks(Object instance, String added, String changed, String removed) { |
| 798 | ensureNotActive(); |
| 799 | // if at least one valid callback is specified, we turn off auto configuration, unless |
| 800 | // someone already explicitly invoked autoConfig |
| 801 | if ((added != null || removed != null || changed != null) && ! m_autoConfigInvoked) { |
| 802 | setAutoConfig(false); |
| 803 | } |
| 804 | m_callbackInstance = instance; |
| 805 | m_callbackAdded = added; |
| 806 | m_callbackChanged = changed; |
| 807 | m_callbackRemoved = removed; |
| 808 | return this; |
| 809 | } |
| 810 | |
| 811 | private void ensureNotActive() { |
| 812 | if (m_tracker != null) { |
| 813 | throw new IllegalStateException("Cannot modify state while active."); |
| 814 | } |
| 815 | } |
| 816 | |
| 817 | public synchronized String toString() { |
| 818 | return "ServiceDependency[" + m_trackedServiceName + " " + m_trackedServiceFilterUnmodified + "]"; |
| 819 | } |
| 820 | |
| 821 | public String getAutoConfigName() { |
| 822 | return m_autoConfigInstance; |
| 823 | } |
Marcel Offermans | 001db05 | 2009-12-08 08:58:40 +0000 | [diff] [blame] | 824 | |
| 825 | public Object getAutoConfigInstance() { |
| 826 | return lookupService(); |
| 827 | } |
| 828 | |
| 829 | public Class getAutoConfigType() { |
| 830 | return getInterface(); |
| 831 | } |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 832 | |
| 833 | public String getName() { |
| 834 | StringBuilder sb = new StringBuilder(); |
Marcel Offermans | b1959f4 | 2010-07-01 12:23:51 +0000 | [diff] [blame] | 835 | if (m_trackedServiceName != null) { |
| 836 | sb.append(m_trackedServiceName.getName()); |
| 837 | if (m_trackedServiceFilterUnmodified != null) { |
| 838 | sb.append(' '); |
| 839 | sb.append(m_trackedServiceFilterUnmodified); |
| 840 | } |
| 841 | } |
| 842 | if (m_trackedServiceReference != null) { |
Marcel Offermans | 9e50ef3 | 2010-10-07 11:37:00 +0000 | [diff] [blame] | 843 | sb.append("{service.id=" + m_trackedServiceReference.getProperty(Constants.SERVICE_ID)+"}"); |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 844 | } |
| 845 | return sb.toString(); |
| 846 | } |
| 847 | |
| 848 | public int getState() { |
| 849 | return (isAvailable() ? 1 : 0) + (isRequired() ? 2 : 0); |
| 850 | } |
| 851 | |
| 852 | public String getType() { |
| 853 | return "service"; |
| 854 | } |
Marcel Offermans | 001db05 | 2009-12-08 08:58:40 +0000 | [diff] [blame] | 855 | |
| 856 | public void invokeAdded(DependencyService service) { |
Marcel Offermans | bde9a43 | 2010-05-11 08:01:28 +0000 | [diff] [blame] | 857 | ServiceReference[] refs = m_tracker.getServiceReferences(); |
| 858 | if (refs != null) { |
| 859 | for (int i = 0; i < refs.length; i++) { |
| 860 | ServiceReference sr = refs[i]; |
| 861 | Object svc = m_context.getService(sr); |
| 862 | invokeAdded(service, sr, svc); |
| 863 | } |
| 864 | } |
Marcel Offermans | 001db05 | 2009-12-08 08:58:40 +0000 | [diff] [blame] | 865 | } |
Marcel Offermans | bde9a43 | 2010-05-11 08:01:28 +0000 | [diff] [blame] | 866 | |
Marcel Offermans | 001db05 | 2009-12-08 08:58:40 +0000 | [diff] [blame] | 867 | public void invokeRemoved(DependencyService service) { |
Marcel Offermans | e7baff5 | 2010-12-17 08:51:52 +0000 | [diff] [blame] | 868 | Set references = null; |
| 869 | synchronized (m_sr) { |
| 870 | references = (Set) m_sr.get(service); |
| 871 | } |
Marcel Offermans | 7784e40 | 2011-01-21 20:41:50 +0000 | [diff] [blame^] | 872 | Tuple[] refs = (Tuple[]) (references != null ? references.toArray(new Tuple[references.size()]) : new Tuple[0]); |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 873 | |
| 874 | for (int i = 0; i < refs.length; i++) { |
Marcel Offermans | 7784e40 | 2011-01-21 20:41:50 +0000 | [diff] [blame^] | 875 | ServiceReference sr = refs[i].getServiceReference(); |
| 876 | Object svc = refs[i].getService(); |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 877 | invokeRemoved(service, sr, svc); |
Marcel Offermans | bde9a43 | 2010-05-11 08:01:28 +0000 | [diff] [blame] | 878 | } |
Marcel Offermans | 09e14aa | 2010-11-25 13:36:23 +0000 | [diff] [blame] | 879 | if (references != null) { |
| 880 | references.clear(); |
| 881 | } |
Marcel Offermans | 001db05 | 2009-12-08 08:58:40 +0000 | [diff] [blame] | 882 | } |
Marcel Offermans | 117aa2f | 2009-12-10 09:48:17 +0000 | [diff] [blame] | 883 | |
| 884 | public Dictionary getProperties() { |
Marcel Offermans | 26081d3 | 2010-07-12 12:43:42 +0000 | [diff] [blame] | 885 | ServiceReference reference = lookupServiceReference(); |
| 886 | Object service = lookupService(); |
| 887 | if (reference != null) { |
| 888 | if (m_propagateCallbackInstance != null && m_propagateCallbackMethod != null) { |
| 889 | try { |
| 890 | return (Dictionary) InvocationUtil.invokeCallbackMethod(m_propagateCallbackInstance, m_propagateCallbackMethod, new Class[][] {{ ServiceReference.class, Object.class }, { ServiceReference.class }}, new Object[][] {{ reference, service }, { reference }}); |
| 891 | } |
| 892 | catch (InvocationTargetException e) { |
| 893 | m_logger.log(LogService.LOG_WARNING, "Exception while invoking callback method", e.getCause()); |
| 894 | } |
| 895 | catch (Exception e) { |
| 896 | m_logger.log(LogService.LOG_WARNING, "Exception while trying to invoke callback method", e); |
| 897 | } |
| 898 | throw new IllegalStateException("Could not invoke callback"); |
| 899 | } |
| 900 | else { |
| 901 | Properties props = new Properties(); |
| 902 | String[] keys = reference.getPropertyKeys(); |
| 903 | for (int i = 0; i < keys.length; i++) { |
| 904 | if (!(keys[i].equals(Constants.SERVICE_ID) || keys[i].equals(Constants.SERVICE_PID))) { |
| 905 | props.put(keys[i], reference.getProperty(keys[i])); |
| 906 | } |
| 907 | } |
| 908 | return props; |
| 909 | } |
| 910 | } |
| 911 | else { |
| 912 | throw new IllegalStateException("cannot find service reference"); |
| 913 | } |
Marcel Offermans | 117aa2f | 2009-12-10 09:48:17 +0000 | [diff] [blame] | 914 | } |
| 915 | |
| 916 | public boolean isPropagated() { |
Marcel Offermans | 26081d3 | 2010-07-12 12:43:42 +0000 | [diff] [blame] | 917 | return m_propagate; |
| 918 | } |
| 919 | |
| 920 | public ServiceDependency setPropagate(boolean propagate) { |
| 921 | ensureNotActive(); |
| 922 | m_propagate = propagate; |
| 923 | return this; |
| 924 | } |
| 925 | |
| 926 | public ServiceDependency setPropagate(Object instance, String method) { |
| 927 | setPropagate(instance != null && method != null); |
| 928 | m_propagateCallbackInstance = instance; |
| 929 | m_propagateCallbackMethod = method; |
| 930 | return this; |
Marcel Offermans | 117aa2f | 2009-12-10 09:48:17 +0000 | [diff] [blame] | 931 | } |
Marcel Offermans | 706fb27 | 2010-11-15 12:52:58 +0000 | [diff] [blame] | 932 | |
| 933 | // TODO add equals and hashCode methods, so you can compare dependencies |
Marcel Offermans | a962bc9 | 2009-11-21 17:59:33 +0000 | [diff] [blame] | 934 | } |