diff options
Diffstat (limited to 'sca-java-2.x/tags/2.0.1-RC1/modules/domain-node/src/main/java/org/apache/tuscany/sca/Node.java')
| -rw-r--r-- | sca-java-2.x/tags/2.0.1-RC1/modules/domain-node/src/main/java/org/apache/tuscany/sca/Node.java | 274 |
1 files changed, 274 insertions, 0 deletions
diff --git a/sca-java-2.x/tags/2.0.1-RC1/modules/domain-node/src/main/java/org/apache/tuscany/sca/Node.java b/sca-java-2.x/tags/2.0.1-RC1/modules/domain-node/src/main/java/org/apache/tuscany/sca/Node.java new file mode 100644 index 0000000000..b316ae7cbd --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/domain-node/src/main/java/org/apache/tuscany/sca/Node.java @@ -0,0 +1,274 @@ +/* + * 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; + +import java.io.Reader; +import java.util.List; +import java.util.Map; + +import javax.xml.namespace.QName; +import javax.xml.stream.XMLStreamException; + +import org.apache.tuscany.sca.assembly.Composite; +import org.apache.tuscany.sca.contribution.Contribution; +import org.apache.tuscany.sca.contribution.processor.ContributionReadException; +import org.apache.tuscany.sca.monitor.ValidationException; +import org.apache.tuscany.sca.runtime.ActivationException; +import org.apache.tuscany.sca.runtime.ContributionDescription; +import org.oasisopen.sca.NoSuchServiceException; + +/** + * A Node provides APIs to configure, update, and view an SCA domain + */ +public interface Node { + + /** + * Creates an installed contribution from a supplied root contribution URL. + * See section 10.5.1 of the Assembly Specification. This method is the same + * as calling installContribution(null, contributionURL, null, null) + * + * @param contributionURL the URL where the contribution is located + * @return the URI of the installed contribution + * + * @throws ContributionReadException + * @throws ValidationException + */ + String installContribution(String contributionURL) throws ContributionReadException, ValidationException; + + /** + * Creates an installed contribution from a supplied root contribution and installed at a supplied base URI. + * See section 10.5.1 of the Assembly Specification. + * + * @param uri the base uri of where to install the contribution. May be null in which case a URI is derived from the contribution URL + * @param contributionURL the URL where the contribution is located + * @param metaDataURL the location of an optional generated Contribution Metadata Document. See section 10.2.2 + * of the Assembly Specification. May be null. + * @param dependentContributionURIs specifies the contributions that are used to resolve the dependencies of the + * root contribution and other dependent contributions. May be null. + * @return the URI of the installed contribution + * + * @throws ContributionReadException + * @throws ValidationException + */ + String installContribution(String uri, String contributionURL, String metaDataURL, List<String> dependentContributionURIs) throws ContributionReadException, ValidationException; + + /** + * Creates an installed contribution from a supplied Contribution object. + * See section 10.5.1 of the Assembly Specification. + * + * @param contribution the Contribution object + * @param dependentContributionURIs specifies the contributions that are used to resolve the dependencies of the + * root contribution and other dependent contributions. May be null. + */ + void installContribution(Contribution contribution, List<String> dependentContributionURIs); + + /** + * 4599 10.5.2 add Deployment Composite & update Deployment Composite + * 4600 Adds or updates a deployment composite using a supplied composite ("composite by value" - a data + * 4601 structure, not an existing resource in the Domain) to the contribution identified by a supplied contribution + * 4602 URI. The added or updated deployment composite is given a relative URI that matches the @name + * 4603 attribute of the composite, with a ".composite" suffix. Since all composites run within the context of a + * 4604 installed contribution (any component implementations or other definitions are resolved within that + * 4605 contribution), this functionality makes it possible for the deployer to create a composite with final + * 4606 configuration and wiring decisions and add it to an installed contribution without having to modify the + * 4607 contents of the root contribution. + * 4608 Also, in some use cases, a contribution might include only implementation code (e.g. PHP scripts). It is + * 4609 then possible for those to be given component names by a (possibly generated) composite that is added + * 4610 into the installed contribution, without having to modify the packaging. * + * + * @param contributionURI the URI of the installed contribution to add the composite to + * @param compositeXML the composite to add to the contribution + * @return + * @throws XMLStreamException + * @throws ContributionReadException + * @throws ActivationException + * @throws ValidationException + */ + String addDeploymentComposite(String contributionURI, Reader compositeXML) throws ContributionReadException, XMLStreamException, ActivationException, ValidationException; + + /** + * 4599 10.5.2 add Deployment Composite & update Deployment Composite + * 4600 Adds or updates a deployment composite using a supplied composite ("composite by value" - a data + * 4601 structure, not an existing resource in the Domain) to the contribution identified by a supplied contribution + * 4602 URI. The added or updated deployment composite is given a relative URI that matches the @name + * 4603 attribute of the composite, with a ".composite" suffix. Since all composites run within the context of a + * 4604 installed contribution (any component implementations or other definitions are resolved within that + * 4605 contribution), this functionality makes it possible for the deployer to create a composite with final + * 4606 configuration and wiring decisions and add it to an installed contribution without having to modify the + * 4607 contents of the root contribution. + * 4608 Also, in some use cases, a contribution might include only implementation code (e.g. PHP scripts). It is + * 4609 then possible for those to be given component names by a (possibly generated) composite that is added + * 4610 into the installed contribution, without having to modify the packaging. * + * + * @param contributionURI the URI of the installed contribution to add the composite to + * @param composite the Composite to add to the contribution + * @return + * @throws XMLStreamException + * @throws ContributionReadException + * @throws ActivationException + * @throws ValidationException + */ + String addDeploymentComposite(String contributionURI, Composite composite) throws ActivationException, ValidationException; + + /** + * 4611 11.4.310.5.3 remove Contribution + * 4612 Removes the deployed contribution identified by a supplied contribution URI. + * + * @param contributionURI + * @return List of contribution URIs (includes dependent contributions) which were removed + */ + void uninstallContribution(String contributionURI); + + /** + * 4677 10.7.1 add To Domain-Level Composite + * 4678 This functionality adds the composite identified by a supplied URI to the Domain Level Composite. The + * 4679 supplied composite URI refers to a composite within an installed contribution. The composite's installed + * 4680 contribution determines how the composite's artifacts are resolved (directly and indirectly). The supplied + * 4681 composite is added to the domain composite with semantics that correspond to the domain-level + * 4683 components become top-level components and the component services become externally visible + * 4684 services (eg. they would be present in a WSDL description of the Domain). The meaning of any promoted + * 4685 services and references in the supplied composite is not defined; since there is no composite scope + * 4686 outside the domain composite, the usual idea of promotion has no utility. + * + * @param cotributionURI + * @param compositeURI + * @throws ActivationException + * @throws ValidationException + * @throws ContributionReadException + */ + void startComposite(String contributionURI, String compositeURI) throws ActivationException, ValidationException, ContributionReadException; + void startComposite(String contributionURI, String compositeURI, String nodeName) throws ActivationException; + + void stopCompositeAndUninstallUnused(String contributionURI, String compositeURI) throws ActivationException; + + /** + * 4687 10.7.2 remove From Domain-Level Composite + * 4688 Removes from the Domain Level composite the elements corresponding to the composite identified by a + * 4689 supplied composite URI. This means that the removal of the components, wires, services and references + * 4690 originally added to the domain level composite by the identified composite. + * @param contributionURI + * @param compositeURI + * @throws ActivationException + */ + void stopComposite(String contributionURI, String compositeURI) throws ActivationException; + + /** + * Starts all the deployable composites in a contriubution + * @param contributionURI + * @return the list of composite URIs which were started + * @throws ActivationException + * @throws ValidationException + * @throws ContributionReadException + */ + List<String> startDeployables(String contributionURI) throws ActivationException, ValidationException, ContributionReadException; + + /** + * 10.7.3 get Domain-Level Composite + * Returns a <composite> definition that has an <include> line for each composite that had been added to + * the domain level composite. It is important to note that, in dereferencing the included composites, any + * referenced artifacts are resolved in terms of that installed composite. + * + * @return + */ + Composite getDomainComposite(); + + /** + * 4695 10.7.4 get QName Definition + * 4696 In order to make sense of the domain-level composite (as returned by get Domain-Level Composite), it + * 4697 needs to be possible to get the definitions for named artifacts in the included composites. This + * 4698 functionality takes the supplied URI of an installed contribution (which provides the context), a supplied + * 4699 qualified name of a definition to look up, and a supplied symbol space (as a QName, e.g. + * 4700 wsdl:PortTypeportType). The result is a single definition, in whatever form is appropriate for that + * 4701 definition type. + * 4702 Note that this, like all the other domain-level operations, is a conceptual operation. Its capabilities need to + * 4703 exist in some form, but not necessarily as a service operation with exactly this signature. + * @param contributionURI + * @param definition + * @param symbolSpace + * @return + */ + Object getQNameDefinition(String contributionURI, QName definition, QName symbolSpace); + +// /** +// * Probably want to be able to stop it all at once so a method called stop or shutdown or destroy +// */ + void stop(); + + /** + * Would also be convenient to get service proxys as from SCAClientFactory + */ + <T> T getService(Class<T> interfaze, String serviceURI) throws NoSuchServiceException; + + /** + * Get the URIs of any composites that have been started in the domain + * @return a map with key contributionURI and value a list of the started compositeURIs + */ + Map<String, List<String>> getStartedCompositeURIs(); + + /** + * Get the URIs of all the contributions installed on this Node + * @return the list of installed contribution URIs + */ + List<String> getInstalledContributionURIs(); + + /** + * Get an installed Contribution + * @param uri the URI of the contribution + * @return the Contribution + * @throws ValidationException + * @throws ContributionReadException + */ + Contribution getContribution(String uri) throws ContributionReadException, ValidationException; + + /** + * Gets the Domain URI used to configure this Node. + * + * @return the domain uri string + */ + String getDomainURI(); + + /** + * Gets the Domain name of this Node. + * + * @return the domain name + */ + String getDomainName(); + + List<String> getDeployableCompositeURIs(String contributionURI); + // TODO: should this be exposed on the interface? + public ContributionDescription getInstalledContribution(String contributionURI); + + void validateContribution(String string) throws ContributionReadException, ValidationException; + + // TODO: should these member getters be replaced with a getDomainRegistry? + List<String> getNodeNames(); + String getLocalNodeName(); + String getRunningNodeName(String contributionURI, String compositeURI); + + // TODO: Add methods to get: + // get/display contribution content + // a view-only Node + // dirty started composites (contributions updated while composite running) + // adding foreign endpoints to support domain federation, eg perhaps: + // void addForeignEndpoint(String serviceName, Binding b); + // void removeForeignEndpoint(String serviceName); + // List<String> getForeignEndpoints(); + // Binding getForeignEndpoint(String serviceName); +} |