diff options
Diffstat (limited to 'sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager')
5 files changed, 595 insertions, 0 deletions
diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/LICENSE b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/LICENSE new file mode 100644 index 0000000000..8aa906c321 --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/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/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/NOTICE b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/NOTICE new file mode 100644 index 0000000000..ad2ba40961 --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/NOTICE @@ -0,0 +1,6 @@ +${pom.name} +Copyright (c) 2005 - 2010 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). + diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/pom.xml b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/pom.xml new file mode 100644 index 0000000000..08b79a770d --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/pom.xml @@ -0,0 +1,88 @@ +<?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>1.6</version> + <relativePath>../pom.xml</relativePath> + </parent> + <artifactId>tuscany-workspace-manager</artifactId> + <name>Apache Tuscany SCA Domain Workspace Manager</name> + + <dependencies> + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-sca-api</artifactId> + <version>1.6</version> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-contribution</artifactId> + <version>1.6</version> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-assembly</artifactId> + <version>1.6</version> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-workspace</artifactId> + <version>1.6</version> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-workspace-impl</artifactId> + <version>1.6</version> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-host-embedded</artifactId> + <version>1.6</version> + </dependency> + + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + + <configuration> + <instructions> + <Bundle-Version>${tuscany.version}</Bundle-Version> + <Bundle-SymbolicName>org.apache.tuscany.sca.workspace</Bundle-SymbolicName> + <Bundle-Description>${pom.name}</Bundle-Description> + <Export-Package>org.apache.tuscany.sca.workspace*</Export-Package> + </instructions> + </configuration> + </plugin> + </plugins> + </build> + +</project> diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManager.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManager.java new file mode 100644 index 0000000000..0ea82f8e86 --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/src/main/java/org/apache/tuscany/sca/workspace/manager/WorkspaceManager.java @@ -0,0 +1,106 @@ +/* + * 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.Workspace; +import org.apache.tuscany.sca.workspace.manager.impl.WorkspaceManagerImpl; +import org.osoa.sca.ServiceRuntimeException; + +/** + * This workspace manager class provides an SPI for firing up the Tuscany runtime + * and for providing access to the Tuscany ExtensionPointRegsitry. With a reference to the + * registry you can add new extension points programmatically before starting the runtime. + * Once the runtime is started you can read contributions, create a workspace, populate it + * and then resolve it. + * + * A workspace is a collection of contributions. A workspace populated + * with one or more contribution models can be resolved to ensure + * that all referenced artifacts are located. When more than one contribution + * model is present resolution takes into account the import and export relationships + * between contributions. + */ +public abstract class WorkspaceManager { + + /** + * Get a new instance of the WorkspaceManager. Each call will create a + * distinct instance. + * + * @return workspace manager + */ + public static WorkspaceManager newInstance() throws ServiceRuntimeException{ + try { + // replace with service discovery lookup? + return new WorkspaceManagerImpl(); + } catch(Exception ex){ + throw new ServiceRuntimeException(ex); + } + } + + /** + * 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 abstract 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 abstract void start() throws ServiceRuntimeException; + + /** + * Remove any resources being held by the runtime + */ + public abstract void stop() throws ServiceRuntimeException; + + /** + * Create an empty workspace + * + * @return workspace + */ + public abstract Workspace createWorkspace() throws ServiceRuntimeException; + + /** + * Create a contribution model by reading from the specified location URL + * + * @param name the URI that's given to the contribution + * @param location the URL of the contribution to be read + */ + public abstract Contribution readContribution(String name, String location) throws ServiceRuntimeException; + + /** + * Add a contribution to a workspace + * + * @param workspace the workspace to be extended + * @param contribution the contribution to be added + */ + public abstract void addContributionToWorkspace(Workspace workspace, Contribution contribution) throws ServiceRuntimeException; + + /** + * Resolve all of the contributions in the workspace + * + * @param workspace + */ + public abstract void resolveWorkspace(Workspace workspace) throws ServiceRuntimeException; +} diff --git a/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/src/main/java/org/apache/tuscany/sca/workspace/manager/impl/WorkspaceManagerImpl.java b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/src/main/java/org/apache/tuscany/sca/workspace/manager/impl/WorkspaceManagerImpl.java new file mode 100644 index 0000000000..f95f74ab2c --- /dev/null +++ b/sca-java-1.x/tags/1.6.1-TUSCANY-3909/workspace-manager/src/main/java/org/apache/tuscany/sca/workspace/manager/impl/WorkspaceManagerImpl.java @@ -0,0 +1,190 @@ +/* + * 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.impl; + +import java.io.File; +import java.net.URI; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import org.apache.tuscany.sca.contribution.Contribution; +import org.apache.tuscany.sca.contribution.ModelFactoryExtensionPoint; +import org.apache.tuscany.sca.contribution.processor.URLArtifactProcessor; +import org.apache.tuscany.sca.contribution.processor.URLArtifactProcessorExtensionPoint; +import org.apache.tuscany.sca.contribution.resolver.ExtensibleModelResolver; +import org.apache.tuscany.sca.core.ExtensionPointRegistry; +import org.apache.tuscany.sca.core.UtilityExtensionPoint; +import org.apache.tuscany.sca.host.embedded.impl.ReallySmallRuntime; +import org.apache.tuscany.sca.monitor.Monitor; +import org.apache.tuscany.sca.monitor.MonitorFactory; +import org.apache.tuscany.sca.monitor.Problem; +import org.apache.tuscany.sca.monitor.Problem.Severity; +import org.apache.tuscany.sca.workspace.Workspace; +import org.apache.tuscany.sca.workspace.WorkspaceFactory; +import org.apache.tuscany.sca.workspace.builder.ContributionDependencyBuilder; +import org.apache.tuscany.sca.workspace.builder.impl.ContributionDependencyBuilderImpl; +import org.apache.tuscany.sca.workspace.manager.WorkspaceManager; +import org.osoa.sca.ServiceRuntimeException; + +/** + * This workspace manager class provides an SPI for firing up the Tuscany runtime + * and for providing access to the Tuscany ExtensionPointRegsitry. With a reference to the + * registry you can add new extension points programmatically before starting the runtime. + * Once the runtime is started you can read contributions, create a workspace, populate it + * and then resolve it. + * + * A workspace is a collection of contributions. A workspace populated + * with one or more contribution models can be resolved to ensure + * that all referenced artifacts are located. When more than one contribution + * model is present resolution takes into account the import and export relationships + * between contributions. + */ +public class WorkspaceManagerImpl extends WorkspaceManager { + + private ReallySmallRuntime runtime; + + private ModelFactoryExtensionPoint modelFactories; + private URLArtifactProcessorExtensionPoint artifactProcessorExtensions; + private UtilityExtensionPoint utilities; + + private WorkspaceFactory workspaceFactory; + private URLArtifactProcessor<Contribution> contributionProcessor; + private ContributionDependencyBuilder contributionDependencyBuilder; + private MonitorFactory monitorFactory; + private Monitor monitor; + + public WorkspaceManagerImpl() throws ServiceRuntimeException{ + try { + runtime = new ReallySmallRuntime(Thread.currentThread().getContextClassLoader()); + + ExtensionPointRegistry registry = getRegistry(); + + modelFactories = registry.getExtensionPoint(ModelFactoryExtensionPoint.class); + artifactProcessorExtensions = registry.getExtensionPoint(URLArtifactProcessorExtensionPoint.class); + utilities = registry.getExtensionPoint(UtilityExtensionPoint.class); + + workspaceFactory = modelFactories.getFactory(WorkspaceFactory.class); + contributionProcessor = artifactProcessorExtensions.getProcessor(Contribution.class); + monitorFactory = utilities.getUtility(MonitorFactory.class); + monitor = monitorFactory.createMonitor(); + + contributionDependencyBuilder = new ContributionDependencyBuilderImpl(monitor); + + } catch(Exception ex) { + throw new ServiceRuntimeException(ex); + } + } + + public ExtensionPointRegistry getRegistry(){ + return runtime.getExtensionPointRegistry(); + } + + public void start() throws ServiceRuntimeException { + try { + runtime.start(); + } catch(Exception ex) { + throw new ServiceRuntimeException(ex); + } + } + + public void stop() throws ServiceRuntimeException{ + try { + runtime.stop(); + } catch(Exception ex) { + throw new ServiceRuntimeException(ex); + } + } + + public Workspace createWorkspace(){ + Workspace workspace = workspaceFactory.createWorkspace(); + + workspace.setModelResolver(new ExtensibleModelResolver(workspace, getRegistry())); + + return workspace; + } + + + public Contribution readContribution(String name, String location) throws ServiceRuntimeException{ + try { + Contribution returnContribution = + contributionProcessor.read(null, + URI.create(name), + new File(location).toURI().toURL()); + + analyzeProblems(); + + return returnContribution; + + } catch (Exception ex) { + throw new ServiceRuntimeException(ex); + } + } + + public void addContributionToWorkspace(Workspace workspace, Contribution contribution) throws ServiceRuntimeException{ + try { + + workspace.getContributions().add(contribution); + + + } catch (Exception ex) { + throw new ServiceRuntimeException(ex); + } + } + + public void resolveWorkspace(Workspace workspace) throws ServiceRuntimeException { + try { + // an algorithm to resolve contributions given their dependencies + // need to look at the one from 2.x as this one expects contributions + // to be presented in the right order + Set<Contribution> resolved = new HashSet<Contribution>(); + for (Contribution contribution: workspace.getContributions()) { + List<Contribution> dependencies = contributionDependencyBuilder.buildContributionDependencies(contribution, workspace); + + // Resolve contributions + for (Contribution dependency: dependencies) { + if (!resolved.contains(dependency)) { + resolved.add(dependency); + contributionProcessor.resolve(contribution, workspace.getModelResolver()); + } + } + } + + analyzeProblems(); + + } catch (Exception ex) { + throw new ServiceRuntimeException(ex); + } + } + + private void analyzeProblems() throws Exception { + + for (Problem problem : monitor.getProblems()) { + if ((problem.getSeverity() == Severity.ERROR) && (!problem.getMessageId().equals("SchemaError"))) { + if (problem.getCause() != null) { + throw problem.getCause(); + } else { + throw new ServiceRuntimeException(problem.toString()); + } + } + } + } + +} |