Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +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 | */ |
| 19 | package org.apache.felix.dm.impl; |
| 20 | |
| 21 | import java.util.ArrayList; |
| 22 | import java.util.Enumeration; |
| 23 | import java.util.List; |
| 24 | import java.util.Properties; |
| 25 | |
Marcel Offermans | a8818d5 | 2011-03-09 10:03:35 +0000 | [diff] [blame] | 26 | import org.apache.felix.dm.Component; |
| 27 | import org.apache.felix.dm.ComponentStateListener; |
Marcel Offermans | 8b93efa | 2010-07-02 18:27:21 +0000 | [diff] [blame] | 28 | import org.apache.felix.dm.Dependency; |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 29 | import org.apache.felix.dm.DependencyManager; |
Marcel Offermans | 8b93efa | 2010-07-02 18:27:21 +0000 | [diff] [blame] | 30 | import org.apache.felix.dm.ServiceDependency; |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 31 | import org.osgi.framework.Constants; |
| 32 | import org.osgi.framework.ServiceReference; |
| 33 | |
| 34 | /** |
| 35 | * Aspect Service implementation. This class extends the FilterService in order to catch |
| 36 | * some Service methods for configuring actual aspect service implementation. |
Marcel Offermans | 5be5f14 | 2011-04-26 10:47:12 +0000 | [diff] [blame] | 37 | * |
| 38 | * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a> |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 39 | */ |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 40 | public class AspectServiceImpl extends FilterService { |
Xander Uiterlinden | b64a8e2 | 2012-04-03 14:42:23 +0000 | [diff] [blame] | 41 | public AspectServiceImpl(DependencyManager dm, Class aspectInterface, String aspectFilter, int ranking, String autoConfig, String add, String change, String remove, String swap) |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 42 | { |
Marcel Offermans | faaed47 | 2010-09-08 10:07:32 +0000 | [diff] [blame] | 43 | super(dm.createComponent()); // This service will be filtered by our super class, allowing us to take control. |
Xander Uiterlinden | b64a8e2 | 2012-04-03 14:42:23 +0000 | [diff] [blame] | 44 | m_component.setImplementation(new AspectImpl(aspectInterface, aspectFilter, ranking, autoConfig, add, change, remove, swap)) |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 45 | .add(dm.createServiceDependency() |
| 46 | .setService(aspectInterface, createDependencyFilterForAspect(aspectFilter)) |
| 47 | .setAutoConfig(false) |
| 48 | .setCallbacks("added", "removed")); |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 49 | } |
| 50 | |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 51 | private String createDependencyFilterForAspect(String filter) { |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 52 | // we only want to match services which are not themselves aspects |
| 53 | if (filter == null || filter.length() == 0) { |
| 54 | return "(!(" + DependencyManager.ASPECT + "=*))"; |
| 55 | } |
| 56 | else { |
| 57 | return "(&(!(" + DependencyManager.ASPECT + "=*))" + filter + ")"; |
| 58 | } |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * This class is the Aspect Implementation. It will create the actual Aspect Service, and |
| 63 | * will use the Aspect Service parameters provided by our enclosing class. |
| 64 | */ |
| 65 | class AspectImpl extends AbstractDecorator { |
| 66 | private final Class m_aspectInterface; // the service decorated by this aspect |
| 67 | private final String m_aspectFilter; // the service filter decorated by this aspect |
| 68 | private final int m_ranking; // the aspect ranking |
Marcel Offermans | a8818d5 | 2011-03-09 10:03:35 +0000 | [diff] [blame] | 69 | private final String m_autoConfig; // the aspect impl field name where to inject decorated service |
| 70 | private final String m_add; |
| 71 | private final String m_change; |
| 72 | private final String m_remove; |
Xander Uiterlinden | b64a8e2 | 2012-04-03 14:42:23 +0000 | [diff] [blame] | 73 | private final String m_swap; |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 74 | |
Xander Uiterlinden | b64a8e2 | 2012-04-03 14:42:23 +0000 | [diff] [blame] | 75 | public AspectImpl(Class aspectInterface, String aspectFilter, int ranking, String autoConfig, String add, String change, String remove, String swap) { |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 76 | m_aspectInterface = aspectInterface; |
| 77 | m_aspectFilter = aspectFilter; |
| 78 | m_ranking = ranking; |
Marcel Offermans | a8818d5 | 2011-03-09 10:03:35 +0000 | [diff] [blame] | 79 | m_autoConfig = autoConfig; |
| 80 | m_add = add; |
| 81 | m_change = change; |
| 82 | m_remove = remove; |
Xander Uiterlinden | b64a8e2 | 2012-04-03 14:42:23 +0000 | [diff] [blame] | 83 | m_swap = swap; |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 84 | } |
| 85 | |
Marcel Offermans | faaed47 | 2010-09-08 10:07:32 +0000 | [diff] [blame] | 86 | public Component createService(Object[] params) { |
Marcel Offermans | 66df0b8 | 2011-04-27 21:48:41 +0000 | [diff] [blame] | 87 | List dependencies = m_component.getDependencies(); |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 88 | // remove our internal dependency |
| 89 | dependencies.remove(0); |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 90 | // replace it with one that points to the specific service that just was passed in |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 91 | Properties serviceProperties = getServiceProperties(params); |
| 92 | String[] serviceInterfaces = getServiceInterfaces(); |
Marcel Offermans | a8818d5 | 2011-03-09 10:03:35 +0000 | [diff] [blame] | 93 | ServiceReference ref = (ServiceReference) params[0]; |
| 94 | ServiceDependency dependency = m_manager.createServiceDependency().setService(m_aspectInterface, createAspectFilter(ref)).setRequired(true); |
| 95 | if (m_autoConfig != null) { |
| 96 | dependency.setAutoConfig(m_autoConfig); |
| 97 | } |
Xander Uiterlinden | b64a8e2 | 2012-04-03 14:42:23 +0000 | [diff] [blame] | 98 | if (m_add != null || m_change != null || m_remove != null || m_swap != null) { |
| 99 | dependency.setCallbacks(m_add, m_change, m_remove, m_swap); |
Marcel Offermans | a8818d5 | 2011-03-09 10:03:35 +0000 | [diff] [blame] | 100 | } |
Marcel Offermans | faaed47 | 2010-09-08 10:07:32 +0000 | [diff] [blame] | 101 | Component service = m_manager.createComponent() |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 102 | .setInterface(serviceInterfaces, serviceProperties) |
| 103 | .setImplementation(m_serviceImpl) |
| 104 | .setFactory(m_factory, m_factoryCreateMethod) // if not set, no effect |
| 105 | .setComposition(m_compositionInstance, m_compositionMethod) // if not set, no effect |
| 106 | .setCallbacks(m_callbackObject, m_init, m_start, m_stop, m_destroy) // if not set, no effect |
Marcel Offermans | a8818d5 | 2011-03-09 10:03:35 +0000 | [diff] [blame] | 107 | .add(dependency); |
Marcel Offermans | b1959f4 | 2010-07-01 12:23:51 +0000 | [diff] [blame] | 108 | |
Marcel Offermans | 66df0b8 | 2011-04-27 21:48:41 +0000 | [diff] [blame] | 109 | configureAutoConfigState(service, m_component); |
Marcel Offermans | 3d92121 | 2010-08-09 13:37:02 +0000 | [diff] [blame] | 110 | |
Marcel Offermans | e9c13d9 | 2010-07-01 14:01:02 +0000 | [diff] [blame] | 111 | for (int i = 0; i < dependencies.size(); i++) { |
| 112 | service.add(((Dependency) dependencies.get(i)).createCopy()); |
Marcel Offermans | b1959f4 | 2010-07-01 12:23:51 +0000 | [diff] [blame] | 113 | } |
| 114 | |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 115 | for (int i = 0; i < m_stateListeners.size(); i++) { |
Marcel Offermans | faaed47 | 2010-09-08 10:07:32 +0000 | [diff] [blame] | 116 | service.addStateListener((ComponentStateListener) m_stateListeners.get(i)); |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 117 | } |
| 118 | return service; |
| 119 | } |
| 120 | |
| 121 | private Properties getServiceProperties(Object[] params) { |
| 122 | ServiceReference ref = (ServiceReference) params[0]; |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 123 | Properties props = new Properties(); |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 124 | String[] keys = ref.getPropertyKeys(); |
| 125 | for (int i = 0; i < keys.length; i++) { |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 126 | String key = keys[i]; |
| 127 | if (key.equals(Constants.SERVICE_ID) || key.equals(Constants.SERVICE_RANKING) || key.equals(DependencyManager.ASPECT) || key.equals(Constants.OBJECTCLASS)) { |
| 128 | // do not copy these |
| 129 | } |
| 130 | else { |
| 131 | props.put(key, ref.getProperty(key)); |
| 132 | } |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 133 | } |
| 134 | if (m_serviceProperties != null) { |
| 135 | Enumeration e = m_serviceProperties.keys(); |
| 136 | while (e.hasMoreElements()) { |
| 137 | Object key = e.nextElement(); |
| 138 | props.put(key, m_serviceProperties.get(key)); |
| 139 | } |
| 140 | } |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 141 | // finally add our aspect property |
| 142 | props.put(DependencyManager.ASPECT, ref.getProperty(Constants.SERVICE_ID)); |
| 143 | // and the ranking |
| 144 | props.put(Constants.SERVICE_RANKING, Integer.valueOf(m_ranking)); |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 145 | return props; |
| 146 | } |
| 147 | |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 148 | private String[] getServiceInterfaces() { |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 149 | List serviceNames = new ArrayList(); |
| 150 | // Of course, we provide the aspect interface. |
| 151 | serviceNames.add(m_aspectInterface.getName()); |
| 152 | // But also append additional aspect implementation interfaces. |
| 153 | if (m_serviceInterfaces != null) { |
| 154 | for (int i = 0; i < m_serviceInterfaces.length; i ++) { |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 155 | if (!m_serviceInterfaces[i].equals(m_aspectInterface.getName())) { |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 156 | serviceNames.add(m_serviceInterfaces[i]); |
| 157 | } |
| 158 | } |
| 159 | } |
| 160 | return (String[]) serviceNames.toArray(new String[serviceNames.size()]); |
| 161 | } |
| 162 | |
Marcel Offermans | 129a7a5 | 2010-08-20 12:18:59 +0000 | [diff] [blame] | 163 | private String createAspectFilter(ServiceReference ref) { |
| 164 | Long sid = (Long) ref.getProperty(Constants.SERVICE_ID); |
| 165 | return "(&(|(!(" + Constants.SERVICE_RANKING + "=*))(" + Constants.SERVICE_RANKING + "<=" + (m_ranking - 1) + "))(|(" + Constants.SERVICE_ID + "=" + sid + ")(" + DependencyManager.ASPECT + "=" + sid + ")))"; |
| 166 | } |
Pierre De Rop | 19476fe | 2010-05-23 08:13:58 +0000 | [diff] [blame] | 167 | } |
| 168 | } |