diff options
author | dims <dims@13f79535-47bb-0310-9956-ffa450edef68> | 2008-06-17 00:23:01 +0000 |
---|---|---|
committer | dims <dims@13f79535-47bb-0310-9956-ffa450edef68> | 2008-06-17 00:23:01 +0000 |
commit | bdd0a41aed7edf21ec2a65cfa17a86af2ef8c48a (patch) | |
tree | 38a92061c0793434c4be189f1d70c3458b6bc41d /branches/sca-java-1.2/modules/domain-api |
Move Tuscany from Incubator to top level.
git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@668359 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'branches/sca-java-1.2/modules/domain-api')
7 files changed, 598 insertions, 0 deletions
diff --git a/branches/sca-java-1.2/modules/domain-api/DISCLAIMER b/branches/sca-java-1.2/modules/domain-api/DISCLAIMER new file mode 100644 index 0000000000..d68a410903 --- /dev/null +++ b/branches/sca-java-1.2/modules/domain-api/DISCLAIMER @@ -0,0 +1,8 @@ +Apache Tuscany is an effort undergoing incubation at The Apache Software
+Foundation (ASF), sponsored by the Apache Web Services PMC. Incubation is
+required of all newly accepted projects until a further review indicates that
+the infrastructure, communications, and decision making process have stabilized
+in a manner consistent with other successful ASF projects. While incubation
+status is not necessarily a reflection of the completeness or stability of the
+code, it does indicate that the project has yet to be fully endorsed by the ASF.
+
diff --git a/branches/sca-java-1.2/modules/domain-api/LICENSE b/branches/sca-java-1.2/modules/domain-api/LICENSE new file mode 100644 index 0000000000..8aa906c321 --- /dev/null +++ b/branches/sca-java-1.2/modules/domain-api/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/branches/sca-java-1.2/modules/domain-api/NOTICE b/branches/sca-java-1.2/modules/domain-api/NOTICE new file mode 100644 index 0000000000..fdfa0e9faa --- /dev/null +++ b/branches/sca-java-1.2/modules/domain-api/NOTICE @@ -0,0 +1,6 @@ +${pom.name} +Copyright (c) 2005 - 2008 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). + diff --git a/branches/sca-java-1.2/modules/domain-api/pom.xml b/branches/sca-java-1.2/modules/domain-api/pom.xml new file mode 100644 index 0000000000..a687ca1881 --- /dev/null +++ b/branches/sca-java-1.2/modules/domain-api/pom.xml @@ -0,0 +1,42 @@ +<?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.2-incubating-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> + </parent> + + <artifactId>tuscany-domain-api</artifactId> + <name>Apache Tuscany SCA Domain API</name> + + <dependencies> + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-sca-api</artifactId> + <version>1.2-incubating-SNAPSHOT</version> + </dependency> + + </dependencies> + +</project> diff --git a/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/DomainException.java b/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/DomainException.java new file mode 100644 index 0000000000..1a62801b1b --- /dev/null +++ b/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/DomainException.java @@ -0,0 +1,53 @@ +/* + * 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.domain; + + +/** + * Denotes an error starting the runtime + * + * @version $Rev: 568826 $ $Date: 2007-08-23 06:27:34 +0100 (Thu, 23 Aug 2007) $ + */ +public class DomainException extends Exception { + + static final long serialVersionUID = 2096658015909178325L; + + private String message; + + public DomainException() { + } + + public DomainException(String message) { + super(message); + setMessage(message); + } + + public DomainException(Throwable cause) { + super(cause); + setMessage(cause.getMessage()); + } + + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } +} diff --git a/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/SCADomain.java b/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/SCADomain.java new file mode 100644 index 0000000000..e88a18a534 --- /dev/null +++ b/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/SCADomain.java @@ -0,0 +1,207 @@ +/* + * 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.domain; + +import java.net.URL; + +import javax.xml.namespace.QName; + +import org.osoa.sca.CallableReference; +import org.osoa.sca.ServiceReference; + + +/** + * Represents an SCA domain. + * + * @version $Rev: 580520 $ $Date: 2007-09-29 00:50:25 +0100 (Sat, 29 Sep 2007) $ + */ +public interface SCADomain { + + /** + * Start all of the services in the domain. + */ + public void start() + throws DomainException; + + /** + * Stop all of the services in the domain. + */ + public void stop() + throws DomainException; + + /** + * Destroy the SCA domain. + */ + public void destroy() + throws DomainException; + + /** + * Returns the URI of the SCA Domain. That URI is the endpoint of the + * SCA domain administration service. + * + * @return the URI of the SCA Domain + */ + public String getURI(); + + /** + * Add an SCA contribution to the domain. + * + * @param contributionURI the URI of the contribution + * @param contributionURL the URL of the contribution + * @throws DomainException + */ + public void addContribution(String contributionURI, URL contributionURL) + throws DomainException; + + /** + * Update an SCA contribution that has previousle been added to the domain. + * + * @param contributionURI the URI of the contribution + * @param contributionURL the URL of the contribution + * @throws DomainException + */ + public void updateContribution(String contributionURI, URL contributionURL) + throws DomainException; + + /** + * Remove a contribution from the domain. + * + * @param contributionURI the URI of the contribution + * @throws DomainException + */ + public void removeContribution(String contributionURI) + throws DomainException; + + /** + * Add the supplied composite XML to the identified contribution + * + * @param contributionURI the URI of the contribution + * @param compositeXML the XML string of the composite + * @throws DomainException + */ + public void addDeploymentComposite(String contributionURI, String compositeXML) + throws DomainException; + + /** + * Use the supplied composite XML to update the identified contribution + * + * @param contributionURI the URI of the contribution + * @param compositeXML the XML string of the composite + * @throws DomainException + */ + public void updateDeploymentComposite(String contributionURI, String compositeXML) + throws DomainException; + + /** + * Add a deployable composite to the domain. + * + * @param compositeQName the QName of the composite + * @throws DomainException + */ + public void addToDomainLevelComposite(QName compositeQName) + throws DomainException; + + /** + * Remove a deployable composite from the domain. + * + * @param compositeQName the QName of the composite + * @throws DomainException + */ + public void removeFromDomainLevelComposite(QName compositeQName) + throws DomainException; + + /** + * Returns an XML string representation of the domain level composite + * + * @return xml representing the domain level composite + */ + public String getDomainLevelComposite() + throws DomainException; + + /** + * Returns an XML String representation of a artifact from within the + * domain namespace formed by the domain level composite + * + * @return xml representing the specified artifact + */ + public String getQNameDefinition(QName artifact) + throws DomainException; + + /** + * Start a composite. The domain is responsible for starting all the + * components in the composite. It may decompose the composite into + * one or more smaller composites and load these composites into + * an appropriate SCA node for execution. + * + * @param compositeQName The QName of the composite + * @throws DomainException + */ + public void startComposite(QName compositeQName) + throws DomainException; + + /** + * Stop a composite. The domain will stop all the components from the + * specified composite. + * + * @param compositeQName The QName of the composite + * @throws DomainException + */ + public void stopComposite(QName compositeQName) + throws DomainException; + + /** + * Cast a type-safe reference to a CallahbleReference. Converts a type-safe + * reference to an equivalent CallableReference; if the target refers to a + * service then a ServiceReference will be returned, if the target refers to + * a callback then a CallableReference will be returned. + * + * @param target a reference proxy provided by the SCA runtime + * @param <B> the Java type of the business interface for the reference + * @param <R> the type of reference to be returned + * @return a CallableReference equivalent for the proxy + * @throws IllegalArgumentException if the supplied instance is not a + * reference supplied by the SCA runtime + */ + public <B, R extends CallableReference<B>> R cast(B target) throws IllegalArgumentException; + + /** + * Returns a proxy for a service provided by a component in the SCA domain. + * + * @param businessInterface the interface that will be used to invoke the + * service + * @param serviceName the name of the service + * @param <B> the Java type of the business interface for the service + * @return an object that implements the business interface + */ + public <B> B getService(Class<B> businessInterface, String serviceName); + + /** + * Returns a ServiceReference for a service provided by a component in the + * SCA domain. + * + * @param businessInterface the interface that will be used to invoke the + * service + * @param serviceName the name of the service + * @param <B> the Java type of the business interface for the service + * @return a ServiceReference for the designated service + */ + public <B> ServiceReference<B> getServiceReference(Class<B> businessInterface, String referenceName); + +}
\ No newline at end of file diff --git a/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/SCADomainFactory.java b/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/SCADomainFactory.java new file mode 100644 index 0000000000..860ab0171b --- /dev/null +++ b/branches/sca-java-1.2/modules/domain-api/src/main/java/org/apache/tuscany/sca/domain/SCADomainFactory.java @@ -0,0 +1,77 @@ +/* + * 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.domain; + +import java.lang.reflect.Constructor; + +import org.osoa.sca.ServiceRuntimeException; + +/** + * A factory for SCA domains. + * + * @version $Rev: 580520 $ $Date: 2007-09-29 00:50:25 +0100 (Sat, 29 Sep 2007) $ + */ +public abstract class SCADomainFactory { + + + /** + * Returns a new SCA domain factory instance. + * + * @return a new SCA domain factory + */ + public static SCADomainFactory newInstance() { + + SCADomainFactory scaDomainFactory = null; + + try { + final ClassLoader classLoader = SCADomainFactory.class.getClassLoader(); + String className = "org.apache.tuscany.sca.domain.impl.SCADomainFactoryImpl"; + + Class cls = Class.forName(className, true, classLoader); + + Constructor<?> constructor = null; + + try { + constructor = cls.getConstructor(); + } catch (NoSuchMethodException e) { + // ignore + } + + if (constructor != null) { + scaDomainFactory = (SCADomainFactory)constructor.newInstance(); + } + + return scaDomainFactory; + + } catch (Exception e) { + throw new ServiceRuntimeException(e); + } + } + + /** + * Creates a new SCA domain. + * + * @param domainURI the URI of the domain, this is the endpoint + * URI of the domain administration service + * @return a new SCA domain + */ + public abstract SCADomain createSCADomain(String domainURI) throws DomainException; + +} |