diff options
Diffstat (limited to 'sca-java-1.x/tags/1.2/modules/node-api')
10 files changed, 843 insertions, 0 deletions
diff --git a/sca-java-1.x/tags/1.2/modules/node-api/DISCLAIMER b/sca-java-1.x/tags/1.2/modules/node-api/DISCLAIMER new file mode 100644 index 0000000000..d68a410903 --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-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/sca-java-1.x/tags/1.2/modules/node-api/LICENSE b/sca-java-1.x/tags/1.2/modules/node-api/LICENSE new file mode 100644 index 0000000000..8aa906c321 --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-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/sca-java-1.x/tags/1.2/modules/node-api/NOTICE b/sca-java-1.x/tags/1.2/modules/node-api/NOTICE new file mode 100644 index 0000000000..fdfa0e9faa --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-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/sca-java-1.x/tags/1.2/modules/node-api/pom.xml b/sca-java-1.x/tags/1.2/modules/node-api/pom.xml new file mode 100644 index 0000000000..fb0447631d --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-api/pom.xml @@ -0,0 +1,48 @@ +<?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</version> + <relativePath>../pom.xml</relativePath> + </parent> + + <artifactId>tuscany-node-api</artifactId> + <name>Apache Tuscany SCA Node API</name> + + <dependencies> + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-sca-api</artifactId> + <version>1.2-incubating</version> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-domain-api</artifactId> + <version>1.2-incubating</version> + </dependency> + + </dependencies> + +</project> diff --git a/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/NodeException.java b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/NodeException.java new file mode 100644 index 0000000000..5ef2aee114 --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/NodeException.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.node; + + +/** + * Denotes an error starting the runtime + * + * @version $Rev: 568826 $ $Date: 2007-08-23 06:27:34 +0100 (Thu, 23 Aug 2007) $ + */ +public class NodeException extends Exception { + + static final long serialVersionUID = 2096658015909178325L; + + private String message; + + public NodeException() { + } + + public NodeException(String message) { + super(message); + setMessage(message); + } + + public NodeException(Throwable cause) { + super(cause); + setMessage(cause.getMessage()); + } + + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } +} diff --git a/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCADomainAccess.java b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCADomainAccess.java new file mode 100644 index 0000000000..bae5a086b0 --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCADomainAccess.java @@ -0,0 +1,75 @@ +/* + * 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.node; + +import java.net.URL; + +import javax.xml.namespace.QName; + +import org.osoa.sca.CallableReference; +import org.osoa.sca.ServiceReference; + + +/** + * Provides access to the components in a domain. + * + * @version $Rev$ $Date$ + */ +public interface SCADomainAccess { + + /** + * 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/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCADomainFinder.java b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCADomainFinder.java new file mode 100644 index 0000000000..d915a34cd8 --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCADomainFinder.java @@ -0,0 +1,78 @@ +/* + * 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.node; + +import java.lang.reflect.Constructor; + +import org.apache.tuscany.sca.domain.DomainException; +import org.apache.tuscany.sca.domain.SCADomain; +import org.osoa.sca.ServiceRuntimeException; + +/** + * A finder for SCA domains. + * + * @version $Rev: 580520 $ $Date: 2007-09-29 00:50:25 +0100 (Sat, 29 Sep 2007) $ + */ +public abstract class SCADomainFinder { + + + /** + * Returns a new SCA domain finder instance. + * + * @return a new SCA domain finder + */ + public static SCADomainFinder newInstance() { + SCADomainFinder scaDomainFinder = null; + + try { + final ClassLoader classLoader = SCADomainFinder.class.getClassLoader(); + String className = "org.apache.tuscany.sca.node.impl.SCADomainFinderImpl"; + + Class cls = Class.forName(className, true, classLoader); + + Constructor<?> constructor = null; + + try { + constructor = cls.getConstructor(); + } catch (NoSuchMethodException e) { + // ignore + } + + if (constructor != null) { + scaDomainFinder = (SCADomainFinder)constructor.newInstance(); + } + + return scaDomainFinder; + + } catch (Exception e) { + throw new ServiceRuntimeException(e); + } + } + + /** + * Finds an existing SCA domain. + * + * @param domainURI the URI of the domain, this is the endpoint + * URI of the domain administration service + * @return the SCA domain + */ + public abstract SCADomain getSCADomain(String domainURI) throws DomainException; + +} diff --git a/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCANode.java b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCANode.java new file mode 100644 index 0000000000..676b0f7f8b --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCANode.java @@ -0,0 +1,98 @@ +/* + * 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.node; + +import java.net.URL; + +import javax.xml.namespace.QName; + +import org.apache.tuscany.sca.domain.SCADomain; +import org.osoa.sca.annotations.Remotable; + +/** + * Represents an SCA processing node. An SCA node belongs to an SCA domain. + * A node is loaded with one or mode SCA composites. It can start and stop that composite. + * + * @version $Rev: 580520 $ $Date: 2007-09-29 00:50:25 +0100 (Sat, 29 Sep 2007) $ + */ +@Remotable +public interface SCANode { + + /** + * Returns the URI of the SCA node. That URI is the endpoint of the + * SCA node administration service. + * + * @return the URI of the SCA node + */ + public String getURI(); + + /** + * Returns the SCA domain that the node belongs to. + * + * @return the SCA domain that the node belongs to + */ + public SCADomain getDomain(); + + /** + * Add an SCA contribution into the node. + * + * @param contributionURI the URI of the contribution + * @param contributionURL the URL of the contribution + */ + public void addContribution(String contributionURI, URL contributionURL) throws NodeException; + + /** + * Remove an SCA contribution from the node. + * + * @param contributionURI the URI of the contribution + */ + public void removeContribution(String contributionURI) throws NodeException; + + /** + * Add the named deployable composite to the domain level composite + * + * @param compositeQName the name of the composite + */ + public void addToDomainLevelComposite(QName compositeQName) throws NodeException; + + /** + * Add the specified deployable composite to the domain level composite + * + * @param compositePath the path of the composite file + */ + public void addToDomainLevelComposite(String compositePath) throws NodeException; + + /** + * Start all the deployed composites + */ + public void start() throws NodeException; + + /** + * Stop all of the deployed composites + */ + public void stop() throws NodeException; + + /** + * Destroy the node. + */ + public void destroy() throws NodeException; + + +} diff --git a/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCANodeFactory.java b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCANodeFactory.java new file mode 100644 index 0000000000..1cba8a08f4 --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/SCANodeFactory.java @@ -0,0 +1,161 @@ +/* + * 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.node; + +import java.lang.reflect.Constructor; +import java.net.URL; + +import org.apache.tuscany.sca.node.util.SCAContributionUtil; +import org.osoa.sca.ServiceRuntimeException; + +/** + * A factory for SCA processing nodes. An SCA processing node can be loaded + * with an SCA composite. + * + * @version $Rev: 579871 $ $Date: 2007-09-27 03:20:34 +0100 (Thu, 27 Sep 2007) $ + */ +public abstract class SCANodeFactory { + + + /** + * Returns a new SCA node factory instance. + * + * @return a new SCA node factory + */ + public static SCANodeFactory newInstance() { + SCANodeFactory scaNodeFactory = null; + + try { + final ClassLoader classLoader = SCANodeFactory.class.getClassLoader(); + String className = "org.apache.tuscany.sca.node.impl.SCANodeFactoryImpl"; + + Class cls = Class.forName(className, true, classLoader); + + Constructor<?> constructor = null; + + try { + constructor = cls.getConstructor(); + } catch (NoSuchMethodException e) { + // ignore + } + + if (constructor != null) { + scaNodeFactory = (SCANodeFactory)constructor.newInstance(); + } + + return scaNodeFactory; + + } catch (Exception e) { + throw new ServiceRuntimeException(e); + } + } + + private static SCANodeFactory singletonInstance; + + /** + * Returns a singleton SCA node factory instance, and creates a new + * singleton instance if none exists. + * + * @return an SCA node factory + */ + public static SCANodeFactory getInstance() { + if (singletonInstance == null) { + singletonInstance = newInstance(); + } + return singletonInstance; + } + + /** + * Creates a new SCA node. + * + * @param nodeURI the URI of the node, this URI is used to provide the default + * host and port information for the runtime for situations when bindings + * do provide this information + * @param domainURI the URI of the domain that the node belongs to. This URI is + * used to locate the domain manager on the network + * @return a new SCA node. + */ + public abstract SCANode createSCANode(String physicalNodeURI, String domainURI) throws NodeException; + + /** + * Creates a new SCA node. Many physical nodes may share the same logical URL in load balancing + * and failover scenarios where each node in the group runs the same contribution and + * active composites + * + * @param physicalNodeURI the URI of the node, this URI is used to provide the default + * host and port information for the runtime for situations when bindings + * don't provide this information + * @param domainURI the URI of the domain that the node belongs to. This URI is + * used to locate the domain manager on the network + * @param logicalNodeURI the uri of the node to be used in situations where more than one node + * are grouped together for failover or load balancing scenarios. The logicalNodeURI + * will typically identify the logical node where requests are sent + * @return a new SCA node. + */ + public abstract SCANode createSCANode(String physicalNodeURI, String domainURI, String logicalNodeURI) throws NodeException; + + /** + * Creates a new SCA node. Many physical nodes may share the same logical URL in load balancing + * and failover scenarios where each node in the group runs the same contribution and + * active composites. Also allows a class loaded to b specified. This is the + * classloader that will be used to load the management application used by the + * node to talk to the domain + * + * @param physicalNodeURI the URI of the node, this URI is used to provide the default + * host and port information for the runtime for situations when bindings + * don't provide this information + * @param domainURI the URI of the domain that the node belongs to. This URI is + * used to locate the domain manager on the network + * @param logicalNodeURI the uri of the node to be used in situations where more than one node + * are grouped together for failover or load balancing scenarios. The logicalNodeURI + * will typically identify the logical node where requests are sent. If null is provided + * no logicalNodeURI is set. + * @param classLoader the class loader to use by default when loading contributions. If null is provided + * the classloader the dervied automatically. + * @return a new SCA node. + */ + public abstract SCANode createSCANode(String physicalNodeURI, String domainURI, String logicalNodeURI, ClassLoader classLoader) throws NodeException; + + + /** + * Convenience method to create and start a node and embedded domain + * that deploys a single composite within a single contribution. + * + * @param composite the composite to be deployed. + * @return a new SCA node. + */ + public static SCANode createNodeWithComposite(String composite) throws NodeException { + try { + final ClassLoader loader = Thread.currentThread().getContextClassLoader(); + final URL url = SCAContributionUtil.findContributionFromResource(loader, composite); + + final SCANode node = getInstance().createSCANode(null, null); + node.addContribution(url.toString(), url); + node.addToDomainLevelComposite(composite); + node.start(); + + return node; + + } catch (Exception e) { + throw new NodeException(e); + } + } + +} diff --git a/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/util/SCAContributionUtil.java b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/util/SCAContributionUtil.java new file mode 100644 index 0000000000..f3b532ed8c --- /dev/null +++ b/sca-java-1.x/tags/1.2/modules/node-api/src/main/java/org/apache/tuscany/sca/node/util/SCAContributionUtil.java @@ -0,0 +1,111 @@ +/* + * 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.node.util; + +import java.io.File; +import java.net.MalformedURLException; +import java.net.URL; + + +/** + * Utility methods to find an SCA contribution from a class or a resource. + * + * @version $Rev$ $Date$ + */ +public class SCAContributionUtil { + + /** + * Given a class this method finds the contribution that it belongs to. + * This could be either a local directory of a jar file. + * + * @param clazz + * @return the contribution URL + * @throws MalformedURLException + */ + public static URL findContributionFromClass(Class<?> clazz) throws MalformedURLException { + return findContributionFromResource(clazz.getClassLoader(), clazz.getName().replace('.', '/') + ".class"); + } + + /** + * Given the path to a resource this method finds the contribution that it belongs to + * this could be either a local directory of a jar file. + * + * @param classLoader + * @param compositeString + * @return the contribution URL + * @throws MalformedURLException + */ + public static URL findContributionFromResource(ClassLoader classLoader, String compositeString) throws MalformedURLException { + + URL contributionURL = classLoader.getResource(compositeString); + + if ( contributionURL != null ){ + String contributionURLString = contributionURL.toExternalForm(); + String protocol = contributionURL.getProtocol(); + + if ("file".equals(protocol)) { + // directory contribution + if (contributionURLString.endsWith(compositeString)) { + String location = contributionURLString.substring(0, contributionURLString.lastIndexOf(compositeString)); + // workaround from evil url/uri form maven + contributionURL = toFile(new URL(location)).toURI().toURL(); + } + + } else if ("jar".equals(protocol)) { + // jar contribution + String location = contributionURLString.substring(4, contributionURLString.lastIndexOf("!/")); + // workaround for evil url/uri from maven + contributionURL = toFile(new URL(location)).toURI().toURL(); + } + } + + return contributionURL; + } + + /** + * Convert from a <code>URL</code> to a <code>File</code>. + * <p> + * From version 1.1 this method will decode the URL. Syntax such as + * <code>file:///my%20docs/file.txt</code> will be correctly decoded to + * <code>/my docs/file.txt</code>. + * + * @param url the file URL to convert, null returns null + * @return the equivalent <code>File</code> object, or <code>null</code> + * if the URL's protocol is not <code>file</code> + * @throws IllegalArgumentException if the file is incorrectly encoded + */ + private static File toFile(URL url) { + if (url == null || !url.getProtocol().equals("file")) { + return null; + } else { + String filename = url.getFile().replace('/', File.separatorChar); + int pos = 0; + while ((pos = filename.indexOf('%', pos)) >= 0) { // NOPMD + if (pos + 2 < filename.length()) { + String hexStr = filename.substring(pos + 1, pos + 3); + char ch = (char)Integer.parseInt(hexStr, 16); + filename = filename.substring(0, pos) + ch + filename.substring(pos + 3); + } + } + return new File(filename); + } + } + +}
\ No newline at end of file |