diff options
Diffstat (limited to 'sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime')
3 files changed, 607 insertions, 0 deletions
diff --git a/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProvider.java b/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProvider.java new file mode 100644 index 0000000000..1d5d99cd34 --- /dev/null +++ b/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProvider.java @@ -0,0 +1,336 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.tuscany.sca.implementation.osgi.runtime; + +import static org.apache.tuscany.sca.implementation.osgi.OSGiProperty.REMOTE_CONFIG_SCA; +import static org.apache.tuscany.sca.implementation.osgi.OSGiProperty.SCA_REFERENCE; +import static org.apache.tuscany.sca.implementation.osgi.OSGiProperty.SERVICE_IMPORTED; +import static org.apache.tuscany.sca.implementation.osgi.OSGiProperty.SERVICE_IMPORTED_CONFIGS; +import static org.osgi.framework.Constants.SERVICE_RANKING; + +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.security.AccessController; +import java.security.PrivilegedAction; +import java.util.ArrayList; +import java.util.Hashtable; +import java.util.List; + +import org.apache.tuscany.sca.assembly.ComponentReference; +import org.apache.tuscany.sca.assembly.ComponentService; +import org.apache.tuscany.sca.assembly.EndpointReference; +import org.apache.tuscany.sca.assembly.Extensible; +import org.apache.tuscany.sca.core.invocation.ProxyFactory; +import org.apache.tuscany.sca.core.invocation.ProxyFactoryExtensionPoint; +import org.apache.tuscany.sca.implementation.osgi.OSGiImplementation; +import org.apache.tuscany.sca.implementation.osgi.OSGiImplementationFactory; +import org.apache.tuscany.sca.implementation.osgi.OSGiProperty; +import org.apache.tuscany.sca.interfacedef.InterfaceContract; +import org.apache.tuscany.sca.interfacedef.Operation; +import org.apache.tuscany.sca.interfacedef.java.JavaInterface; +import org.apache.tuscany.sca.invocation.Invoker; +import org.apache.tuscany.sca.provider.ImplementationProvider; +import org.apache.tuscany.sca.runtime.RuntimeComponent; +import org.apache.tuscany.sca.runtime.RuntimeComponentReference; +import org.apache.tuscany.sca.runtime.RuntimeComponentService; +import org.apache.tuscany.sca.runtime.RuntimeEndpointReference; +import org.oasisopen.sca.ServiceRuntimeException; +import org.osgi.framework.Bundle; +import org.osgi.framework.BundleContext; +import org.osgi.framework.BundleException; +import org.osgi.framework.InvalidSyntaxException; +import org.osgi.framework.ServiceException; +import org.osgi.framework.ServiceFactory; +import org.osgi.framework.ServiceReference; +import org.osgi.framework.ServiceRegistration; + +/** + * + */ +public class OSGiImplementationProvider implements ImplementationProvider { + private RuntimeComponent component; + private ProxyFactoryExtensionPoint proxyFactoryExtensionPoint; + private Bundle osgiBundle; + private boolean startedByMe; + private OSGiImplementation implementation; + private List<ServiceRegistration> registrations = new ArrayList<ServiceRegistration>(); + private OSGiImplementationFactory implementationFactory; + + public OSGiImplementationProvider(RuntimeComponent component, + OSGiImplementation impl, + ProxyFactoryExtensionPoint proxyFactoryExtensionPoint, + OSGiImplementationFactory implementationFactory) throws BundleException { + this.component = component; + this.proxyFactoryExtensionPoint = proxyFactoryExtensionPoint; + this.implementationFactory = implementationFactory; + this.implementation = impl; + this.osgiBundle = impl.getBundle(); + } + + public Invoker createInvoker(RuntimeComponentService service, Operation operation) { + return new OSGiTargetInvoker(operation, this, service); + } + + public void start() { + // First try to start the osgi bundle + try { + int state = osgiBundle.getState(); + if ((state & Bundle.STARTING) == 0 && (state & Bundle.ACTIVE) == 0) { + osgiBundle.start(); + startedByMe = true; + } + } catch (BundleException e) { + throw new ServiceRuntimeException(e); + } + + for (ComponentReference ref : component.getReferences()) { + RuntimeComponentReference reference = (RuntimeComponentReference)ref; + InterfaceContract interfaceContract = reference.getInterfaceContract(); + final JavaInterface javaInterface = (JavaInterface)interfaceContract.getInterface(); + // final Class<?> interfaceClass = javaInterface.getJavaClass(); + + // final Hashtable<String, Object> props = new Hashtable<String, Object>(); + // props.put(FILTER_MATCH_CRITERIA, ""); + // Collection<String> interfaceNames = new ArrayList<String>(); + // props.put(INTERFACE_MATCH_CRITERIA, interfaceNames); + // interfaceNames.add(interfaceClass.getName()); + + final Hashtable<String, Object> osgiProps = getOSGiProperties(reference); + osgiProps.put(SERVICE_RANKING, Integer.MAX_VALUE); + osgiProps.put(SCA_REFERENCE, component.getURI() + "#reference(" + ref.getName() + ")"); + osgiProps.put(SERVICE_IMPORTED, "true"); + osgiProps.put(SERVICE_IMPORTED_CONFIGS, new String[] {REMOTE_CONFIG_SCA}); + + for (EndpointReference epr : reference.getEndpointReferences()) { + final OSGiServiceFactory serviceFactory = new OSGiServiceFactory(javaInterface.getName(), epr); + ServiceRegistration registration = + AccessController.doPrivileged(new PrivilegedAction<ServiceRegistration>() { + public ServiceRegistration run() { + // Register the proxy as OSGi service + BundleContext context = osgiBundle.getBundleContext(); + ServiceRegistration registration = + context.registerService(javaInterface.getName(), serviceFactory, osgiProps); + return registration; + } + }); + registrations.add(registration); + } + } + + // Set the OSGi service reference properties into the SCA service + for (ComponentService service : component.getServices()) { + // The properties might have been set by the export service + boolean found = false; + for (Object ext : service.getExtensions()) { + if (ext instanceof OSGiProperty) { + found = true; + break; + } + } + if (found) { + continue; + } + ServiceReference serviceReference = getServiceReference(osgiBundle.getBundleContext(), service); + if (serviceReference != null) { + service.getExtensions().addAll(implementationFactory.createOSGiProperties(serviceReference)); + } + } + } + + public void stop() { + for (ServiceRegistration registration : registrations) { + try { + registration.unregister(); + } catch (IllegalStateException e) { + // The service has been unregistered, ignore it + } + } + registrations.clear(); + // [REVIEW] Shoud it take care of stopping the bundle? + if (startedByMe) { + try { + int state = osgiBundle.getState(); + if ((state & Bundle.STOPPING) == 0 && (state & Bundle.ACTIVE) != 0) { + osgiBundle.stop(); + } + } catch (BundleException e) { + throw new ServiceRuntimeException(e); + } finally { + startedByMe = false; + } + } + } + + public boolean supportsOneWayInvocation() { + return false; + } + + /** + * Get all the OSGi properties from the extension list + * @param extensible + * @return + */ + protected Hashtable<String, Object> getOSGiProperties(Extensible extensible) { + Hashtable<String, Object> props = new Hashtable<String, Object>(); + for (Object ext : extensible.getExtensions()) { + if (ext instanceof OSGiProperty) { + OSGiProperty p = (OSGiProperty)ext; + props.put(p.getName(), p.getValue()); + } + } + return props; + } + + protected Object getOSGiService(ComponentService service) { + BundleContext bundleContext = osgiBundle.getBundleContext(); + ServiceReference ref = getServiceReference(bundleContext, service); + if (ref != null) { + Object instance = bundleContext.getService(ref); + return instance; + } else { + return null; + } + } + + private ServiceReference getServiceReference(BundleContext bundleContext, ComponentService service) { + JavaInterface javaInterface = (JavaInterface)service.getInterfaceContract().getInterface(); + // String filter = getOSGiFilter(provider.getOSGiProperties(service)); + // FIXME: What is the filter? + String filter = "(!(" + SERVICE_IMPORTED + "=*))"; + // "(sca.service=" + component.getURI() + "#service-name\\(" + service.getName() + "\\))"; + ServiceReference ref; + try { + ref = bundleContext.getServiceReferences(javaInterface.getName(), filter)[0]; + } catch (InvalidSyntaxException e) { + throw new ServiceRuntimeException(e); + } + return ref; + } + + RuntimeComponent getComponent() { + return component; + } + + OSGiImplementation getImplementation() { + return implementation; + } + + /** + * A proxy invocation handler that wrap exceptions into OSGi ServiceException + */ + private static class InvocationHandlerDelegate implements InvocationHandler { + private final Object instance; + + public InvocationHandlerDelegate(Object instance) { + super(); + this.instance = instance; + } + + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + if (!Proxy.isProxyClass(instance.getClass())) { + Method m = instance.getClass().getMethod(method.getName(), method.getParameterTypes()); + try { + return m.invoke(instance, args); + } catch (InvocationTargetException e) { + wrapException(method, e.getCause()); + return null; + } + } else { + InvocationHandler handler = Proxy.getInvocationHandler(instance); + try { + return handler.invoke(instance, method, args); + } catch (Throwable e) { + wrapException(method, e); + return null; + } + } + } + + private void wrapException(Method method, Throwable e) throws Throwable { + for (Class<?> exType : method.getExceptionTypes()) { + if (exType.isInstance(e)) { + throw e; + } + } + throw new ServiceException(e.getMessage(), ServiceException.REMOTE, e); + } + + /** + * A utility to cast the object to the given interface. If the class for the object + * is loaded by a different classloader, a proxy will be created. + * + * @param <T> + * @param obj + * @param cls + * @return + */ + static <T> T cast(Object obj, Class<T> cls) { + if (obj == null) { + return null; + } else { + return cls.cast(Proxy.newProxyInstance(cls.getClassLoader(), + new Class<?>[] {cls}, + new InvocationHandlerDelegate(obj))); + } + } + } + + public class OSGiServiceFactory implements ServiceFactory { + private RuntimeEndpointReference epr; + private String interfaceName; + + /** + * @param interfaceName + * @param epr + */ + public OSGiServiceFactory(String interfaceName, EndpointReference epr) { + super(); + this.interfaceName = interfaceName; + this.epr = (RuntimeEndpointReference)epr; + } + + public Object getService(Bundle bundle, ServiceRegistration registration) { + try { + Class<?> interfaceClass = null; + try { + interfaceClass = bundle.loadClass(interfaceName); + } catch (ClassNotFoundException e) { + return null; + } + ProxyFactory proxyService = proxyFactoryExtensionPoint.getInterfaceProxyFactory(); + if (!interfaceClass.isInterface()) { + proxyService = proxyFactoryExtensionPoint.getClassProxyFactory(); + } + Object proxy = proxyService.createProxy(interfaceClass, epr); + return InvocationHandlerDelegate.cast(proxy, interfaceClass); + } catch (Throwable e) { + throw new ServiceException(e.getMessage(), ServiceException.FACTORY_EXCEPTION, e); + } + } + + public void ungetService(Bundle bundle, ServiceRegistration registration, Object service) { + // Do we need to release the proxy? + } + + } + +} diff --git a/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProviderFactory.java b/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProviderFactory.java new file mode 100644 index 0000000000..11b29de248 --- /dev/null +++ b/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProviderFactory.java @@ -0,0 +1,61 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.tuscany.sca.implementation.osgi.runtime; + +import org.apache.tuscany.sca.core.ExtensionPointRegistry; +import org.apache.tuscany.sca.core.FactoryExtensionPoint; +import org.apache.tuscany.sca.core.invocation.ProxyFactoryExtensionPoint; +import org.apache.tuscany.sca.implementation.osgi.OSGiImplementation; +import org.apache.tuscany.sca.implementation.osgi.OSGiImplementationFactory; +import org.apache.tuscany.sca.provider.ImplementationProvider; +import org.apache.tuscany.sca.provider.ImplementationProviderFactory; +import org.apache.tuscany.sca.runtime.RuntimeComponent; +import org.osgi.framework.BundleException; + +/** + * Builds a OSGi-based implementation provider from a component definition + * + * @version $Rev$ $Date$ + */ +public class OSGiImplementationProviderFactory implements ImplementationProviderFactory<OSGiImplementation> { + private OSGiImplementationFactory implementationFactory; + private ProxyFactoryExtensionPoint proxyFactoryExtensionPoint; + + public OSGiImplementationProviderFactory(ExtensionPointRegistry registry) { + proxyFactoryExtensionPoint = registry.getExtensionPoint(ProxyFactoryExtensionPoint.class); + FactoryExtensionPoint factoryExtensionPoint = registry.getExtensionPoint(FactoryExtensionPoint.class); + this.implementationFactory = factoryExtensionPoint.getFactory(OSGiImplementationFactory.class); + } + + public ImplementationProvider createImplementationProvider(RuntimeComponent component, + OSGiImplementation implementation) { + try { + return new OSGiImplementationProvider(component, implementation, proxyFactoryExtensionPoint, + implementationFactory); + } catch (BundleException e) { + throw new RuntimeException(e); + } + + } + + public Class<OSGiImplementation> getModelType() { + return OSGiImplementation.class; + } + +} diff --git a/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiTargetInvoker.java b/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiTargetInvoker.java new file mode 100644 index 0000000000..a9a2fdbd0b --- /dev/null +++ b/sca-java-2.x/tags/2.0-M5.1-RC1/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiTargetInvoker.java @@ -0,0 +1,210 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.tuscany.sca.implementation.osgi.runtime; + +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.Hashtable; +import java.util.List; + +import org.apache.tuscany.sca.interfacedef.DataType; +import org.apache.tuscany.sca.interfacedef.Interface; +import org.apache.tuscany.sca.interfacedef.Operation; +import org.apache.tuscany.sca.interfacedef.java.JavaOperation; +import org.apache.tuscany.sca.invocation.Invoker; +import org.apache.tuscany.sca.invocation.Message; +import org.apache.tuscany.sca.runtime.RuntimeComponent; +import org.apache.tuscany.sca.runtime.RuntimeComponentService; +import org.osgi.framework.Constants; + +/** + * The Invoker looks up the corresponding OSGi service from the OSGi service registry + * and delegate the call to it. + * + * @version $Rev$ $Date$ + */ +public class OSGiTargetInvoker implements Invoker { + + private Operation operation; + + private final OSGiImplementationProvider provider; + private final RuntimeComponent component; + private final RuntimeComponentService service; + + public OSGiTargetInvoker(Operation operation, OSGiImplementationProvider provider, RuntimeComponentService service) { + + this.operation = operation; + this.service = service; + this.provider = provider; + this.component = provider.getComponent(); + + } + + private Object invokeTarget(Message msg) throws InvocationTargetException { + + Operation op = msg.getOperation(); + if (op == null) { + op = this.operation; + } + + try { + Object instance = provider.getOSGiService(service); + Method m = findMethod(instance.getClass(), operation); + + Object ret = invokeMethod(instance, m, msg); + + return ret; + } catch (InvocationTargetException e) { + throw e; + } catch (Exception e) { + throw new InvocationTargetException(e); + } + } + + protected Object invokeMethod(Object instance, Method m, Message msg) throws InvocationTargetException { + + try { + + Object payload = msg.getBody(); + + if (payload != null && !payload.getClass().isArray()) { + return m.invoke(instance, payload); + } else { + return m.invoke(instance, (Object[])payload); + } + + } catch (InvocationTargetException e) { + throw e; + } catch (Exception e) { + throw new InvocationTargetException(e); + } + } + + public Message invoke(Message msg) { + try { + Object resp = invokeTarget(msg); + msg.setBody(resp); + } catch (InvocationTargetException e) { + msg.setFaultBody(e.getCause()); + } + return msg; + } + + private String getOSGiFilter(Hashtable<String, Object> props) { + Object serviceID = props.get(Constants.SERVICE_ID); + if (serviceID != null) { + return "(" + Constants.SERVICE_ID + "=" + serviceID + ")"; + } + + String filter = ""; + + if (props != null && props.size() > 0) { + int propCount = 0; + for (String propName : props.keySet()) { + String value = String.valueOf(props.get(propName)); + StringBuffer buf = new StringBuffer(); + for (char c : value.toCharArray()) { + if (c == '(' || c == ')') { + buf.append("\\" + c); + } else { + buf.append(c); + } + } + filter = filter + "(" + propName + "=" + buf.toString() + ")"; + propCount++; + } + + if (propCount > 1) { + filter = "(&" + filter + ")"; + } + } else { + filter = null; + } + return filter; + } + + /** + * @Deprecated + */ + private static Class<?>[] getPhysicalTypes(Operation operation) { + DataType<List<DataType>> inputType = operation.getInputType(); + if (inputType == null) { + return new Class<?>[] {}; + } + List<DataType> types = inputType.getLogical(); + Class<?>[] javaTypes = new Class<?>[types.size()]; + for (int i = 0; i < javaTypes.length; i++) { + Type physical = types.get(i).getPhysical(); + if (physical instanceof Class<?>) { + javaTypes[i] = (Class<?>)physical; + } else { + throw new UnsupportedOperationException(); + } + } + return javaTypes; + } + + /** + * Return the method on the implementation class that matches the operation. + * + * @param implClass the implementation class or interface + * @param operation the operation to match + * @return the method described by the operation + * @throws NoSuchMethodException if no such method exists + * @Deprecated + */ + public static Method findMethod(Class<?> implClass, Operation operation) throws NoSuchMethodException { + String name = operation.getName(); + if (operation instanceof JavaOperation) { + name = ((JavaOperation)operation).getJavaMethod().getName(); + } + Interface interface1 = operation.getInterface(); + int numParams = operation.getInputType().getLogical().size(); + if (interface1 != null && interface1.isRemotable()) { + List<Method> matchingMethods = new ArrayList<Method>(); + for (Method m : implClass.getMethods()) { + if (m.getName().equals(name) && m.getParameterTypes().length == numParams) { + matchingMethods.add(m); + } + } + + // TUSCANY-2180 If there is only one method then we just match on the name + // (this is the same as the existing behaviour) + if (matchingMethods.size() == 1) { + return matchingMethods.get(0); + } + if (matchingMethods.size() > 1) { + // TUSCANY-2180 We need to check the parameter types too + Class<?>[] paramTypes = getPhysicalTypes(operation); + return implClass.getMethod(name, paramTypes); + } + + // No matching method found + throw new NoSuchMethodException("No matching method for operation " + operation.getName() + + " is found on " + + implClass); + } + Class<?>[] paramTypes = getPhysicalTypes(operation); + return implClass.getMethod(name, paramTypes); + } + +} |