TUSCANY-3174 - add a simple WorkspaceManager to allow contributions to be processed in the context of the workspace.

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

4 files changed, 192 insertions, 1 deletions

diff --git a/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/ContributionConfiguration.java b/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/ContributionConfiguration.java
new file mode 100644
index 0000000000..bf885644b0
--- /dev/null
+++ b/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/ContributionConfiguration.java
@@ -0,0 +1,54 @@
+/*
+ * 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.workspace;
+
+/**
+ * Represents an SCA contribution uri + location.
+ */
+public final class ContributionConfiguration {
+    private String uri;
+    private String location;
+    
+    /**
+     * Constructs a new SCA contribution.
+     * 
+     * @param uri The URI that uniquely identifies the contribution in the SCA domain
+     * @param location The URL of the contribution archive
+     */
+    public ContributionConfiguration(String uri, String location) {
+        this.uri = uri;
+        this.location = location;
+    }
+    
+    /**
+     * Get the URI of the contribution
+     * @return The URI that uniquely identifies the contribution in the SCA domain
+     */
+    public String getURI() {
+        return uri;
+    }
+    
+    /**
+     * The location of the contribution
+     * @return The URL of the contribution archive
+     */
+    public String getLocation() {
+        return location;
+    }
+}
\ No newline at end of file
diff --git a/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceFactoryImpl.java b/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceFactoryImpl.java
index e41cc3ea83..99ecbb4c0c 100644
--- a/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceFactoryImpl.java
+++ b/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceFactoryImpl.java
@@ -30,7 +30,7 @@ import org.apache.tuscany.sca.workspace.WorkspaceFactory;
  */
 public class WorkspaceFactoryImpl implements WorkspaceFactory {
     
-    protected WorkspaceFactoryImpl() {
+    public WorkspaceFactoryImpl() {
     }
     
     public Workspace createWorkspace() {
diff --git a/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManager.java b/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManager.java
new file mode 100644
index 0000000000..c7b464ac74
--- /dev/null
+++ b/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManager.java
@@ -0,0 +1,90 @@
+/*
+ * 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.workspace.manager;
+
+import org.apache.tuscany.sca.contribution.Contribution;
+import org.apache.tuscany.sca.core.ExtensionPointRegistry;
+import org.apache.tuscany.sca.workspace.ContributionConfiguration;
+import org.apache.tuscany.sca.workspace.Workspace;
+
+/**
+ * An SPI for firing up the Tuscany runtime and for providing
+ * access to the ExtensionPointRegsitry. With a reference to the
+ * registry you can add new extension points and then start the
+ * runtime. Once started you can create worksapces and use them
+ * to read and resolve SCA contributions in the same way that 
+ * Tuscany does internally. 
+ */
+public interface WorkspaceManager {
+		
+	/**
+	 * If you want to add new extensions to the extension point
+	 * registry and have the runtime take notice of them you need
+	 * to do this before calling start
+	 */
+	public ExtensionPointRegistry getRegistry();
+	
+	/**
+	 * Starting the runtime creates the extensible model processors and 
+	 * resolvers based on the extension points currently found in the
+	 * extension point registry. 
+	 */
+	public void start();
+
+	/**
+	 * Remove any resources being held by the runtime 
+	 */
+	public void stop();
+	
+    /**
+     * Create an empty workspace
+     * 
+     * @return workspace
+     */
+	public Workspace createWorkspace();
+		
+	// should the following operations be on the manager or on the workspace itself
+	
+	/**
+	 * Add a contribution to a workspace and create the contribution model in the process
+	 * 
+	 * @param workspace the workspace to be extended
+	 * @param contribution the configuration information of the contribution to be added
+	 */
+	public Contribution addContributionToWorkspace(Workspace workspace, Contribution contribution);
+	
+	// Should we have an operation that allows a whole workspace to be created at once
+	// programmatically from a configuration ?
+	
+	/**
+	 * Resolve all of the contributions in the workspace
+	 * 
+	 * @param workspace
+	 */
+	public void resolveWorkspace(Workspace workspace);
+	
+	/**
+	 * Remove a contribution from the workspace
+	 * 
+	 * @param workspace the workspace to be changes
+	 * @param contribution the contribution to be removed
+	 */
+	public void removeContributionFromWorkspace(Workspace workspace, Contribution contribution);
+}
diff --git a/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManagerFactory.java b/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManagerFactory.java
new file mode 100644
index 0000000000..25cd6b3a12
--- /dev/null
+++ b/branches/sca-java-1.x/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManagerFactory.java
@@ -0,0 +1,47 @@
+/*
+ * 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.workspace.manager;
+
+import org.osoa.sca.ServiceRuntimeException;
+
+
+/**
+ * A factory for creating workspace managers. A workspace manager has an instance
+ * of the Tuscany runtime and creates workspaces for collecting and processing
+ * contributions 
+ */
+public abstract class WorkspaceManagerFactory {
+	
+	/**
+	 * Get a new instance of the WorkspaceManagerFactory. Each call will create a 
+	 * new factory instance
+	 * @return workspace manager factory
+	 */
+	public static WorkspaceManagerFactory newInstance(){
+		try {
+	        Class<?> workspaceManagerFactoryImplClass = Class.forName("org.apache.tuscany.sca.workspace.manager.impl.WorkspaceManagerFactoryImpl");
+	        return (WorkspaceManagerFactory)workspaceManagerFactoryImplClass.newInstance();
+		} catch(Exception ex){
+			throw new ServiceRuntimeException(ex);
+		}
+	}
+	
+	public abstract WorkspaceManager createWorkspaceManager();
+}