diff options
Diffstat (limited to 'tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca')
5 files changed, 571 insertions, 0 deletions
diff --git a/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiDistributionProvider.java b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiDistributionProvider.java new file mode 100644 index 0000000000..ff30730c78 --- /dev/null +++ b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiDistributionProvider.java @@ -0,0 +1,99 @@ +/* + * 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.util.Collection; +import java.util.Map; + +import org.osgi.framework.ServiceReference; + +/** + * Every Distribution Provider registers exactly one Service in the + * ServiceRegistry implementing this interface. The service is registered with + * extra properties identified at the beginning of this interface to denote the + * Distribution Provider product name, version, vendor and supported intents. + */ +public interface OSGiDistributionProvider { + + /** + * Service Registration property for the name of the Distribution Provider + * product. + */ + static final String PROP_KEY_PRODUCT_NAME = "osgi.remote.distribution.product"; + + /** + * Service Registration property for the version of the Distribution + * Provider product. + */ + static final String PROP_KEY_PRODUCT_VERSION = "osgi.remote.distribution.product.version"; + + /** + * Service Registration property for the Distribution Provider product + * vendor name. + */ + static final String PROP_KEY_VENDOR_NAME = "osgi.remote.distribution.vendor"; + + /** + * Service Registration property that lists the intents supported by this + * DistributionProvider. Value of this property is of type + * Collection (<? extends String>). + */ + static final String PROP_KEY_SUPPORTED_INTENTS = "osgi.remote.distribition.supported_intents"; + + /** + * @return ServiceReferences of services registered in the local Service + * Registry that are proxies to remote services. If no proxies are + * registered, then an empty collection is returned. + */ + Collection<ServiceReference> getRemoteServices(); + + /** + * @return ServiceReferences of local services that are exposed remotely + * using this DisitributionProvider. Note that certain services may be + * exposed and without being published to a discovery service. This + * API returns all the exposed services. If no services are exposed an + * empty collection is returned. + */ + Collection<ServiceReference> getExposedServices(); + + /** + * Provides access to extra properties set by the DistributionProvider on + * endpoints, as they will appear on client side proxies given an exposed + * ServiceReference. + * These properties are not always available on the server-side + * ServiceReference of the exposed + * service but will be on the remote client side proxy to this service. + * This API provides access to these extra properties from the exposing + * side. + * E.g. a service is exposed remotely, the distribution software is configured + * to add transactionality to the remote service. Because of this, on the + * client-side proxy the property service.intents=”transactionality” is set. + * However, these intents are *not* always set on the original + * ServiceRegistration on the server-side since on the server side the service + * object is a local pojo which doesn’t provide transactionality by itself. + * This QoS is added by the distribution. + * This API provides access to these extra properties from the server-side. + * + * @param sr A ServiceReference of an exposed service. + * @return The map of extra properties. + */ + Map<String, String> getExposedProperties(ServiceReference sr); + +} diff --git a/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProvider.java b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProvider.java new file mode 100644 index 0000000000..c6e01564db --- /dev/null +++ b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProvider.java @@ -0,0 +1,150 @@ +/* + * 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.security.AccessController; +import java.security.PrivilegedAction; +import java.util.Hashtable; + +import org.apache.tuscany.sca.assembly.ComponentReference; +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.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.RuntimeWire; +import org.oasisopen.sca.ServiceRuntimeException; +import org.osgi.framework.Bundle; +import org.osgi.framework.BundleException; +import org.osgi.framework.Constants; +import org.osgi.framework.ServiceRegistration; + +/** + * + */ +public class OSGiImplementationProvider implements ImplementationProvider { + private RuntimeComponent component; + private ProxyFactoryExtensionPoint proxyFactoryExtensionPoint; + private Bundle osgiBundle; + private OSGiImplementation implementation; + + public OSGiImplementationProvider(RuntimeComponent component, + OSGiImplementation impl, + ProxyFactoryExtensionPoint proxyFactoryExtensionPoint) throws BundleException { + this.component = component; + this.proxyFactoryExtensionPoint = proxyFactoryExtensionPoint; + 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(); + } + } catch (BundleException e) { + throw new ServiceRuntimeException(e); + } + for (ComponentReference ref : component.getReferences()) { + RuntimeComponentReference reference = (RuntimeComponentReference)ref; + InterfaceContract interfaceContract = reference.getInterfaceContract(); + JavaInterface javaInterface = (JavaInterface)interfaceContract.getInterface(); + final Class<?> interfaceClass = javaInterface.getJavaClass(); + + final Hashtable<String, Object> osgiProps = getOSGiProperties(reference); + osgiProps.put(Constants.SERVICE_RANKING, Integer.MAX_VALUE); + osgiProps.put("sca.reference", component.getURI() + "#reference(" + ref.getName() + ")"); + osgiProps.put(OSGiProperty.OSGI_REMOTE, "true"); + osgiProps.put(OSGiProperty.OSGI_REMOTE_CONFIGURATION_TYPE, "sca"); + osgiProps.put(OSGiProperty.OSGI_REMOTE_INTERFACES, interfaceClass.getName()); + + ProxyFactory proxyService = proxyFactoryExtensionPoint.getInterfaceProxyFactory(); + if (!interfaceClass.isInterface()) { + proxyService = proxyFactoryExtensionPoint.getClassProxyFactory(); + } + + for (RuntimeWire wire : reference.getRuntimeWires()) { + final Object proxy = proxyService.createProxy(interfaceClass, wire); + AccessController.doPrivileged(new PrivilegedAction<ServiceRegistration>() { + public ServiceRegistration run() { + return osgiBundle.getBundleContext() + .registerService(interfaceClass.getName(), proxy, osgiProps); + } + }); + } + + } + } + + public void stop() { + // Do we have to unregister the services? + try { + int state = osgiBundle.getState(); + if ((state & Bundle.STOPPING) == 0 && (state & Bundle.ACTIVE) != 0) { + osgiBundle.stop(); + } + } catch (BundleException e) { + throw new ServiceRuntimeException(e); + } + } + + 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; + } + + RuntimeComponent getComponent() { + return component; + } + + OSGiImplementation getImplementation() { + return implementation; + } + +} diff --git a/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProviderFactory.java b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProviderFactory.java new file mode 100644 index 0000000000..0e4a3ef995 --- /dev/null +++ b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationProviderFactory.java @@ -0,0 +1,59 @@ +/* + * 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.invocation.ProxyFactoryExtensionPoint; +import org.apache.tuscany.sca.implementation.osgi.OSGiImplementation; +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 ProxyFactoryExtensionPoint proxyFactoryExtensionPoint; + + public OSGiImplementationProviderFactory(ExtensionPointRegistry extensionPoints) { + proxyFactoryExtensionPoint = extensionPoints.getExtensionPoint(ProxyFactoryExtensionPoint.class); + } + + public ImplementationProvider createImplementationProvider(RuntimeComponent component, + OSGiImplementation implementation) { + + try { + + return new OSGiImplementationProvider(component, implementation, proxyFactoryExtensionPoint); + + } catch (BundleException e) { + throw new RuntimeException(e); + } + + } + + public Class<OSGiImplementation> getModelType() { + return OSGiImplementation.class; + } + +} diff --git a/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationRuntimeActivator.java b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationRuntimeActivator.java new file mode 100644 index 0000000000..f3d59cc513 --- /dev/null +++ b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiImplementationRuntimeActivator.java @@ -0,0 +1,43 @@ +/* + * 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.osgi.framework.BundleActivator; +import org.osgi.framework.BundleContext; + +/** + * Bundle activator to receive the BundleContext + */ +public class OSGiImplementationRuntimeActivator implements BundleActivator { + private static BundleContext bundleContext; + + public void start(BundleContext context) throws Exception { + bundleContext = context; + } + + public void stop(BundleContext context) throws Exception { + bundleContext = null; + } + + static BundleContext getBundleContext() { + return bundleContext; + } + +} diff --git a/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiTargetInvoker.java b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiTargetInvoker.java new file mode 100644 index 0000000000..52313a84e7 --- /dev/null +++ b/tags/java/sca/2.0-M3-RC3/modules/implementation-osgi-runtime/src/main/java/org/apache/tuscany/sca/implementation/osgi/runtime/OSGiTargetInvoker.java @@ -0,0 +1,220 @@ +/* + * 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.core.factory.InstanceWrapper; +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.JavaInterface; +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.BundleContext; +import org.osgi.framework.ServiceReference; + +/** + * 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<T> implements Invoker { + + private Operation operation; + protected InstanceWrapper<T> target; + + 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 { + BundleContext bundleContext = provider.getImplementation().getBundle().getBundleContext(); + JavaInterface javaInterface = (JavaInterface)op.getInterface(); + // String filter = getOSGiFilter(provider.getOSGiProperties(service)); + // FIXME: What is the filter? + String filter = "(!(sca.reference=*))"; + // "(sca.service=" + component.getURI() + "#service-name\\(" + service.getName() + "\\))"; + ServiceReference ref = bundleContext.getServiceReferences(javaInterface.getName(), filter)[0]; + Object instance = bundleContext.getService(ref); + 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) { + + String filter = ""; + + if (props != null && props.size() > 0) { + int propCount = 0; + for (String propName : props.keySet()) { + if (propName.equals("service.pid")) { + continue; + } + 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); + } + +} |