Add a utility for launchers to handle different ways to locate contributions

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

2 files changed, 127 insertions, 0 deletions

diff --git a/sandbox/travelsample/launchers/common/pom.xml b/sandbox/travelsample/launchers/common/pom.xml
new file mode 100644
index 0000000000..d5e03f7200
--- /dev/null
+++ b/sandbox/travelsample/launchers/common/pom.xml
@@ -0,0 +1,45 @@
+<?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-sca</artifactId>
+        <version>1.6-SNAPSHOT</version>
+        <!--relativePath>../../pom.xml</relativePath-->
+    </parent><version>1.0-SNAPSHOT</version>
+    <artifactId>scatours-launcher-common</artifactId>
+    <name>Apache Tuscany SCA Tours Common Utility for Launchers</name>
+
+    <dependencies>
+    
+        <dependency>
+            <groupId>org.apache.tuscany.sca</groupId>
+            <artifactId>tuscany-node-api</artifactId>
+            <version>1.6-SNAPSHOT</version>
+        </dependency>
+        
+
+    </dependencies>
+    
+    <build>
+       <finalName>${artifactId}</finalName>
+    </build>
+</project>
diff --git a/sandbox/travelsample/launchers/common/src/main/java/scatours/launcher/LauncherUtil.java b/sandbox/travelsample/launchers/common/src/main/java/scatours/launcher/LauncherUtil.java
new file mode 100644
index 0000000000..c73c90a14b
--- /dev/null
+++ b/sandbox/travelsample/launchers/common/src/main/java/scatours/launcher/LauncherUtil.java
@@ -0,0 +1,82 @@
+/*
+ * 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 scatours.launcher;
+
+import java.io.File;
+
+import org.apache.tuscany.sca.node.SCAContribution;
+import org.apache.tuscany.sca.node.SCANode;
+import org.apache.tuscany.sca.node.SCANodeFactory;
+
+/**
+ * This utility locates SCA contributions by name so that the launcher can work with various environments where 
+ * contributions are stored differently.
+ */
+public class LauncherUtil {
+
+    /**
+     * Locate an SCA contribution by name
+     * @param name The name of the SCA contribution archive
+     * @return The SCAContribution
+     */
+    public static SCAContribution locate(String name) {
+        // Try to use the target/classes directory inside Eclipse/Maven
+        File file = new File("../../contributions/" + name + "/target/classes");
+        if (!file.exists()) {
+            // Try to use the target/<contribution>.jar that is generated by maven build
+            file = new File("../../contributions/" + name + "/target/" + name + ".jar");
+            if (!file.exists()) {
+                // Try to use the contribution jar under the contributions folder of the distribution
+                file = new File("../contributions/" + name + ".jar");
+                if (!file.exists()) {
+                    throw new IllegalArgumentException("Contribution " + name + " cannot be located.");
+                }
+            }
+        }
+        return new SCAContribution(name, file.toURI().toString());
+    }
+
+    /**
+     * Locate an SCA contribution by replacing the ${name} in the pattern 
+     * @param urlPattern The url pattern that contains ${name}
+     * @param name The name of the contribution archive
+     * @return The SCAContribution
+     */
+    public static SCAContribution locate(String urlPattern, String name) {
+        String url = urlPattern.replace("${name}", name);
+        return new SCAContribution(name, url);
+    }
+
+    /**
+     * Create an SCA node from a list of contribution names
+     * @param composite
+     * @param contributionNames
+     * @return
+     */
+    public static SCANode createNode(String composite, String... contributionNames) {
+        SCAContribution[] contributions = new SCAContribution[contributionNames.length];
+        int index = 0;
+        for (String name : contributionNames) {
+            contributions[index++] = locate(name);
+        }
+        SCANode node = SCANodeFactory.newInstance().createSCANode(composite, contributions);
+        return node;
+    }
+}