Prototyping the provisioning support for Tuscany SCA:

1) Find the "extension" by XML qnames or Java types
2) Resolve the maven dependencies for the "extension"
3) Traverse the contribution/composite model to identify required "extensions"
4) Provision the Node to a runtime that is capable of handling the "extensions"

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@834277 13f79535-47bb-0310-9956-ffa450edef68

5 files changed, 549 insertions, 0 deletions

diff --git a/sandbox/rfeng/tuscany-provisioning/LICENSE b/sandbox/rfeng/tuscany-provisioning/LICENSE
new file mode 100644
index 0000000000..6e529a25c4
--- /dev/null
+++ b/sandbox/rfeng/tuscany-provisioning/LICENSE
@@ -0,0 +1,205 @@
+

+                                 Apache License

+                           Version 2.0, January 2004

+                        http://www.apache.org/licenses/

+

+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

+

+   1. Definitions.

+

+      "License" shall mean the terms and conditions for use, reproduction,

+      and distribution as defined by Sections 1 through 9 of this document.

+

+      "Licensor" shall mean the copyright owner or entity authorized by

+      the copyright owner that is granting the License.

+

+      "Legal Entity" shall mean the union of the acting entity and all

+      other entities that control, are controlled by, or are under common

+      control with that entity. For the purposes of this definition,

+      "control" means (i) the power, direct or indirect, to cause the

+      direction or management of such entity, whether by contract or

+      otherwise, or (ii) ownership of fifty percent (50%) or more of the

+      outstanding shares, or (iii) beneficial ownership of such entity.

+

+      "You" (or "Your") shall mean an individual or Legal Entity

+      exercising permissions granted by this License.

+

+      "Source" form shall mean the preferred form for making modifications,

+      including but not limited to software source code, documentation

+      source, and configuration files.

+

+      "Object" form shall mean any form resulting from mechanical

+      transformation or translation of a Source form, including but

+      not limited to compiled object code, generated documentation,

+      and conversions to other media types.

+

+      "Work" shall mean the work of authorship, whether in Source or

+      Object form, made available under the License, as indicated by a

+      copyright notice that is included in or attached to the work

+      (an example is provided in the Appendix below).

+

+      "Derivative Works" shall mean any work, whether in Source or Object

+      form, that is based on (or derived from) the Work and for which the

+      editorial revisions, annotations, elaborations, or other modifications

+      represent, as a whole, an original work of authorship. For the purposes

+      of this License, Derivative Works shall not include works that remain

+      separable from, or merely link (or bind by name) to the interfaces of,

+      the Work and Derivative Works thereof.

+

+      "Contribution" shall mean any work of authorship, including

+      the original version of the Work and any modifications or additions

+      to that Work or Derivative Works thereof, that is intentionally

+      submitted to Licensor for inclusion in the Work by the copyright owner

+      or by an individual or Legal Entity authorized to submit on behalf of

+      the copyright owner. For the purposes of this definition, "submitted"

+      means any form of electronic, verbal, or written communication sent

+      to the Licensor or its representatives, including but not limited to

+      communication on electronic mailing lists, source code control systems,

+      and issue tracking systems that are managed by, or on behalf of, the

+      Licensor for the purpose of discussing and improving the Work, but

+      excluding communication that is conspicuously marked or otherwise

+      designated in writing by the copyright owner as "Not a Contribution."

+

+      "Contributor" shall mean Licensor and any individual or Legal Entity

+      on behalf of whom a Contribution has been received by Licensor and

+      subsequently incorporated within the Work.

+

+   2. Grant of Copyright License. Subject to the terms and conditions of

+      this License, each Contributor hereby grants to You a perpetual,

+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

+      copyright license to reproduce, prepare Derivative Works of,

+      publicly display, publicly perform, sublicense, and distribute the

+      Work and such Derivative Works in Source or Object form.

+

+   3. Grant of Patent License. Subject to the terms and conditions of

+      this License, each Contributor hereby grants to You a perpetual,

+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

+      (except as stated in this section) patent license to make, have made,

+      use, offer to sell, sell, import, and otherwise transfer the Work,

+      where such license applies only to those patent claims licensable

+      by such Contributor that are necessarily infringed by their

+      Contribution(s) alone or by combination of their Contribution(s)

+      with the Work to which such Contribution(s) was submitted. If You

+      institute patent litigation against any entity (including a

+      cross-claim or counterclaim in a lawsuit) alleging that the Work

+      or a Contribution incorporated within the Work constitutes direct

+      or contributory patent infringement, then any patent licenses

+      granted to You under this License for that Work shall terminate

+      as of the date such litigation is filed.

+

+   4. Redistribution. You may reproduce and distribute copies of the

+      Work or Derivative Works thereof in any medium, with or without

+      modifications, and in Source or Object form, provided that You

+      meet the following conditions:

+

+      (a) You must give any other recipients of the Work or

+          Derivative Works a copy of this License; and

+

+      (b) You must cause any modified files to carry prominent notices

+          stating that You changed the files; and

+

+      (c) You must retain, in the Source form of any Derivative Works

+          that You distribute, all copyright, patent, trademark, and

+          attribution notices from the Source form of the Work,

+          excluding those notices that do not pertain to any part of

+          the Derivative Works; and

+

+      (d) If the Work includes a "NOTICE" text file as part of its

+          distribution, then any Derivative Works that You distribute must

+          include a readable copy of the attribution notices contained

+          within such NOTICE file, excluding those notices that do not

+          pertain to any part of the Derivative Works, in at least one

+          of the following places: within a NOTICE text file distributed

+          as part of the Derivative Works; within the Source form or

+          documentation, if provided along with the Derivative Works; or,

+          within a display generated by the Derivative Works, if and

+          wherever such third-party notices normally appear. The contents

+          of the NOTICE file are for informational purposes only and

+          do not modify the License. You may add Your own attribution

+          notices within Derivative Works that You distribute, alongside

+          or as an addendum to the NOTICE text from the Work, provided

+          that such additional attribution notices cannot be construed

+          as modifying the License.

+

+      You may add Your own copyright statement to Your modifications and

+      may provide additional or different license terms and conditions

+      for use, reproduction, or distribution of Your modifications, or

+      for any such Derivative Works as a whole, provided Your use,

+      reproduction, and distribution of the Work otherwise complies with

+      the conditions stated in this License.

+

+   5. Submission of Contributions. Unless You explicitly state otherwise,

+      any Contribution intentionally submitted for inclusion in the Work

+      by You to the Licensor shall be under the terms and conditions of

+      this License, without any additional terms or conditions.

+      Notwithstanding the above, nothing herein shall supersede or modify

+      the terms of any separate license agreement you may have executed

+      with Licensor regarding such Contributions.

+

+   6. Trademarks. This License does not grant permission to use the trade

+      names, trademarks, service marks, or product names of the Licensor,

+      except as required for reasonable and customary use in describing the

+      origin of the Work and reproducing the content of the NOTICE file.

+

+   7. Disclaimer of Warranty. Unless required by applicable law or

+      agreed to in writing, Licensor provides the Work (and each

+      Contributor provides its Contributions) on an "AS IS" BASIS,

+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

+      implied, including, without limitation, any warranties or conditions

+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A

+      PARTICULAR PURPOSE. You are solely responsible for determining the

+      appropriateness of using or redistributing the Work and assume any

+      risks associated with Your exercise of permissions under this License.

+

+   8. Limitation of Liability. In no event and under no legal theory,

+      whether in tort (including negligence), contract, or otherwise,

+      unless required by applicable law (such as deliberate and grossly

+      negligent acts) or agreed to in writing, shall any Contributor be

+      liable to You for damages, including any direct, indirect, special,

+      incidental, or consequential damages of any character arising as a

+      result of this License or out of the use or inability to use the

+      Work (including but not limited to damages for loss of goodwill,

+      work stoppage, computer failure or malfunction, or any and all

+      other commercial damages or losses), even if such Contributor

+      has been advised of the possibility of such damages.

+

+   9. Accepting Warranty or Additional Liability. While redistributing

+      the Work or Derivative Works thereof, You may choose to offer,

+      and charge a fee for, acceptance of support, warranty, indemnity,

+      or other liability obligations and/or rights consistent with this

+      License. However, in accepting such obligations, You may act only

+      on Your own behalf and on Your sole responsibility, not on behalf

+      of any other Contributor, and only if You agree to indemnify,

+      defend, and hold each Contributor harmless for any liability

+      incurred by, or claims asserted against, such Contributor by reason

+      of your accepting any such warranty or additional liability.

+

+   END OF TERMS AND CONDITIONS

+

+   APPENDIX: How to apply the Apache License to your work.

+

+      To apply the Apache License to your work, attach the following

+      boilerplate notice, with the fields enclosed by brackets "[]"

+      replaced with your own identifying information. (Don't include

+      the brackets!)  The text should be enclosed in the appropriate

+      comment syntax for the file format. We also recommend that a

+      file or class name and description of purpose be included on the

+      same "printed page" as the copyright notice for easier

+      identification within third-party archives.

+

+   Copyright [yyyy] [name of copyright owner]

+

+   Licensed 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.

+

+

+

diff --git a/sandbox/rfeng/tuscany-provisioning/META-INF/MANIFEST.MF b/sandbox/rfeng/tuscany-provisioning/META-INF/MANIFEST.MF
new file mode 100644
index 0000000000..5c8f9482b2
--- /dev/null
+++ b/sandbox/rfeng/tuscany-provisioning/META-INF/MANIFEST.MF
@@ -0,0 +1,16 @@
+Manifest-Version: 1.0

+Main-Class: org.apache.tuscany.sca.provision.ExtensionIntrospector

+Tool: Bnd-0.0.255

+Bundle-Name: Apache Tuscany SCA Provision

+Created-By: 1.6.0_07 (Sun Microsystems Inc.)

+Bundle-Vendor: The Apache Software Foundation

+Bundle-Version: 2.0.0

+Bnd-LastModified: 1225397240796

+Bundle-ManifestVersion: 2

+Bundle-License: http://www.apache.org/licenses/LICENSE-2.0.txt

+Bundle-Description: Apache Tuscany SCA Node Implementation

+Import-Package: org.apache.tuscany.sca.core;version="2.0.0",

+ org.apache.tuscany.sca.extensibility;version="2.0.0"

+Bundle-SymbolicName: org.apache.tuscany.sca.provision

+Bundle-DocURL: http://www.apache.org/

+Bundle-RequiredExecutionEnvironment: J2SE-1.5,JavaSE-1.6
diff --git a/sandbox/rfeng/tuscany-provisioning/NOTICE b/sandbox/rfeng/tuscany-provisioning/NOTICE
new file mode 100644
index 0000000000..51042eab05
--- /dev/null
+++ b/sandbox/rfeng/tuscany-provisioning/NOTICE
@@ -0,0 +1,6 @@
+${pom.name}

+Copyright (c) 2005 - 2009 The Apache Software Foundation

+

+This product includes software developed by

+The Apache Software Foundation (http://www.apache.org/).

+

diff --git a/sandbox/rfeng/tuscany-provisioning/pom.xml b/sandbox/rfeng/tuscany-provisioning/pom.xml
new file mode 100644
index 0000000000..fcaa6aff08
--- /dev/null
+++ b/sandbox/rfeng/tuscany-provisioning/pom.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * 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.
+-->
+<project>
+
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.apache.tuscany.sca</groupId>
+        <artifactId>tuscany-modules</artifactId>
+        <version>2.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>tuscany-provision</artifactId>
+    <name>Apache Tuscany SCA Provisioning</name>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>org.apache.tuscany.sca</groupId>
+            <artifactId>tuscany-extensibility</artifactId>
+            <version>2.0-SNAPSHOT</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.tuscany.sca</groupId>
+            <artifactId>tuscany-implementation-java-runtime</artifactId>
+            <version>2.0-SNAPSHOT</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.tuscany.sca</groupId>
+            <artifactId>tuscany-binding-ws-axis2</artifactId>
+            <version>2.0-SNAPSHOT</version>
+            <scope>test</scope>
+        </dependency>
+
+
+        <dependency>
+            <groupId>org.apache.maven.shared</groupId>
+            <artifactId>maven-runtime</artifactId>
+            <version>1.0-alpha-2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven</groupId>
+            <artifactId>maven-embedder</artifactId>
+            <version>2.0.4</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven</groupId>
+            <artifactId>maven-core</artifactId>
+            <version>2.0.8</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/sandbox/rfeng/tuscany-provisioning/src/main/java/org/apache/tuscany/sca/provision/ExtensionIntrospector.java b/sandbox/rfeng/tuscany-provisioning/src/main/java/org/apache/tuscany/sca/provision/ExtensionIntrospector.java
new file mode 100644
index 0000000000..f3cb381faf
--- /dev/null
+++ b/sandbox/rfeng/tuscany-provisioning/src/main/java/org/apache/tuscany/sca/provision/ExtensionIntrospector.java
@@ -0,0 +1,249 @@
+/*
+ * 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.provision;
+
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import javax.xml.namespace.QName;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
+import org.apache.maven.artifact.repository.ArtifactRepository;
+import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
+import org.apache.maven.artifact.resolver.ArtifactResolutionException;
+import org.apache.maven.artifact.resolver.ArtifactResolutionResult;
+import org.apache.maven.artifact.resolver.ArtifactResolver;
+import org.apache.maven.embedder.MavenEmbedder;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.shared.runtime.DefaultMavenRuntime;
+import org.apache.maven.shared.runtime.MavenRuntime;
+import org.apache.maven.shared.runtime.MavenRuntimeException;
+import org.apache.tuscany.sca.core.DefaultExtensionPointRegistry;
+import org.apache.tuscany.sca.core.ExtensionPointRegistry;
+import org.apache.tuscany.sca.extensibility.ServiceDeclaration;
+import org.apache.tuscany.sca.extensibility.ServiceDeclarationParser;
+import org.apache.tuscany.sca.extensibility.ServiceDiscovery;
+import org.codehaus.plexus.embed.Embedder;
+
+/**
+ * 
+ */
+public class ExtensionIntrospector {
+    private ExtensionPointRegistry registry;
+    private boolean loaded;
+    private MavenRuntime mavenRuntime = new DefaultMavenRuntime();
+    private Map<String, MavenProject> modules = new HashMap<String, MavenProject>();
+    private Map<String, QName> qnames = new HashMap<String, QName>();
+
+    /**
+     * @param registry
+     */
+    public ExtensionIntrospector(ExtensionPointRegistry registry) {
+        super();
+        this.registry = (registry == null) ? new DefaultExtensionPointRegistry() : registry;
+    }
+
+    public MavenProject findModule(String extensionType) {
+        return getModules().get(extensionType);
+    }
+
+    public Map<String, MavenProject> getModules() {
+        loadProviderFactories();
+        return modules;
+    }
+
+    public Map<String, QName> getExtensionTypes() {
+        return qnames;
+    }
+
+    /**
+     * Load provider factories declared under META-INF/services.
+     * @param registry
+     */
+    private synchronized void loadProviderFactories() {
+        if (loaded)
+            return;
+
+        this.qnames.putAll(mapJavaTypeToQName());
+
+        List<ServiceDeclaration> factories = new ArrayList<ServiceDeclaration>();
+        factories.addAll(discover("org.apache.tuscany.sca.provider.BindingProviderFactory"));
+        factories.addAll(discover("org.apache.tuscany.sca.provider.ImplementationProviderFactory"));
+        factories.addAll(discover("org.apache.tuscany.sca.provider.PolicyProviderFactory"));
+        factories.addAll(discover("org.apache.tuscany.sca.provider.WireFormatProviderFactory"));
+        factories.addAll(discover("org.apache.tuscany.sca.provider.OperationSelectorProviderFactory"));
+
+        for (ServiceDeclaration sd : factories) {
+            MavenProject project = null;
+            try {
+                project = mavenRuntime.getProject(sd.getLocation());
+            } catch (MavenRuntimeException e) {
+                e.printStackTrace();
+            }
+            if (project != null) {
+                String model = sd.getAttributes().get("model");
+                modules.put(model, project);
+            }
+        }
+
+        loaded = true;
+    }
+
+    public Map<String, QName> mapJavaTypeToQName() {
+        Collection<ServiceDeclaration> processors =
+            discover("org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor");
+        Map<String, QName> qnames = new HashMap<String, QName>();
+        for (ServiceDeclaration sd : processors) {
+            String qname = sd.getAttributes().get("qname");
+            String model = sd.getAttributes().get("model");
+            qnames.put(model, ServiceDeclarationParser.getQName(qname));
+        }
+        return qnames;
+    }
+
+    /**
+     * Load provider factories declared under META-INF/services.
+     * @param registry
+     * @param factoryClass
+     * @return
+     */
+    private Collection<ServiceDeclaration> discover(String name) {
+
+        // Get the provider factory service declarations
+        Collection<ServiceDeclaration> factoryDeclarations;
+        ServiceDiscovery serviceDiscovery = registry.getServiceDiscovery();
+        try {
+            factoryDeclarations = serviceDiscovery.getServiceDeclarations(name, false);
+        } catch (Exception e) {
+            throw new IllegalStateException(e);
+        }
+
+        return factoryDeclarations;
+    }
+
+    private MavenEmbedder embedder;
+    private ArtifactResolver resolver;
+    private Embedder internalEmbedder;
+    ArtifactMetadataSource artifactMetadataSource;
+    private ArtifactRepository remoteRepo;
+
+    public void start() {
+        try {
+            embedder = new MavenEmbedder();
+            embedder.setClassLoader(Thread.currentThread().getContextClassLoader());
+            embedder.start();
+
+            resolver = getField(embedder, "artifactResolver");
+            internalEmbedder = getField(embedder, "embedder");
+
+            artifactMetadataSource =
+                (ArtifactMetadataSource)internalEmbedder
+                    .lookup("org.apache.maven.artifact.metadata.ArtifactMetadataSource");
+
+            remoteRepo = embedder.createRepository("http://repo2.maven.org/maven2/", "maven");
+        } catch (Throwable e) {
+            throw new IllegalStateException(e);
+        }
+    }
+
+    public void stop() {
+        try {
+            if (embedder != null) {
+                internalEmbedder.release(resolver);
+                internalEmbedder.release(artifactMetadataSource);
+                embedder.stop();
+                embedder = null;
+            }
+        } catch (Throwable e) {
+            throw new IllegalStateException(e);
+        }
+
+    }
+
+    public Map<String, Collection<Artifact>> getDependencies(String args[]) throws ArtifactResolutionException,
+        ArtifactNotFoundException {
+        Map<String, Collection<Artifact>> artifacts = new HashMap<String, Collection<Artifact>>();
+
+        Artifact originatingArtifact = embedder.createArtifact("dummy", "dummy", "1.0", Artifact.SCOPE_RUNTIME, "jar");
+
+        for (Map.Entry<String, MavenProject> e : getModules().entrySet()) {
+            String type = e.getKey();
+            QName qname = qnames.get(e.getKey());
+            if (qname != null) {
+                type = qname.toString();
+            }
+            boolean matched = (args.length == 0);
+            for (String arg : args) {
+                if (type.contains(arg)) {
+                    matched = true;
+                    break;
+                }
+            }
+            if (!matched) {
+                continue;
+            }
+            // System.out.println(type + ": " + e.getValue());
+
+            MavenProject project = e.getValue();
+            Artifact artifact =
+                embedder.createArtifact(project.getGroupId(),
+                                        project.getArtifactId(),
+                                        project.getVersion(),
+                                        Artifact.SCOPE_COMPILE,
+                                        project.getPackaging());
+
+            ArtifactResolutionResult result =
+                resolver.resolveTransitively(Collections.singleton(artifact), originatingArtifact, embedder
+                    .getLocalRepository(), Arrays.asList(remoteRepo), artifactMetadataSource, null);
+
+            // System.out.println("*** " + artifact);
+            artifacts.put(type, result.getArtifacts());
+        }
+        return artifacts;
+    }
+
+    private static <T> T getField(Object object, String name) throws Exception {
+        Field field = object.getClass().getDeclaredField(name);
+        field.setAccessible(true);
+        return (T)field.get(object);
+    }
+
+    public static void main(String args[]) throws Exception {
+        ExtensionIntrospector introspector = new ExtensionIntrospector(null);
+        introspector.start();
+        for (Map.Entry<String, Collection<Artifact>> entry : introspector.getDependencies(args).entrySet()) {
+            System.out.println("\n------------------------------------------------------------------------");
+            System.out.println(entry.getKey());
+            System.out.println("------------------------------------------------------------------------");
+            for (Artifact a : entry.getValue()) {
+                System.out.println(a);
+            }
+            System.out.println("------------------------------------------------------------------------");
+        }
+        introspector.stop();
+    }
+}