1 files changed, 536 insertions, 0 deletions
diff --git a/tags/java/sca/2.0-M3-RC3a/modules/assembly/src/main/java/org/apache/tuscany/sca/assembly/builder/impl/CompositeBindingURIBuilderImpl.java b/tags/java/sca/2.0-M3-RC3a/modules/assembly/src/main/java/org/apache/tuscany/sca/assembly/builder/impl/CompositeBindingURIBuilderImpl.java
new file mode 100644
index 0000000000..6b9d5d9c46
--- /dev/null
+++ b/tags/java/sca/2.0-M3-RC3a/modules/assembly/src/main/java/org/apache/tuscany/sca/assembly/builder/impl/CompositeBindingURIBuilderImpl.java
@@ -0,0 +1,536 @@
+/*
+ * 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.assembly.builder.impl;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.transform.TransformerFactory;
+
+import org.apache.tuscany.sca.assembly.AssemblyFactory;
+import org.apache.tuscany.sca.assembly.Binding;
+import org.apache.tuscany.sca.assembly.Component;
+import org.apache.tuscany.sca.assembly.ComponentProperty;
+import org.apache.tuscany.sca.assembly.ComponentReference;
+import org.apache.tuscany.sca.assembly.ComponentService;
+import org.apache.tuscany.sca.assembly.Composite;
+import org.apache.tuscany.sca.assembly.Contract;
+import org.apache.tuscany.sca.assembly.Implementation;
+import org.apache.tuscany.sca.assembly.Property;
+import org.apache.tuscany.sca.assembly.Reference;
+import org.apache.tuscany.sca.assembly.SCABinding;
+import org.apache.tuscany.sca.assembly.SCABindingFactory;
+import org.apache.tuscany.sca.assembly.Service;
+import org.apache.tuscany.sca.assembly.builder.CompositeBuilder;
+import org.apache.tuscany.sca.assembly.builder.CompositeBuilderException;
+import org.apache.tuscany.sca.definitions.Definitions;
+import org.apache.tuscany.sca.interfacedef.InterfaceContractMapper;
+import org.apache.tuscany.sca.monitor.Monitor;
+
+/**
+ * A composite builder that handles the configuration of binding URIs.
+ *
+ * @version $Rev$ $Date$
+ */
+public class CompositeBindingURIBuilderImpl extends BaseBuilderImpl implements CompositeBuilder {
+
+    @Deprecated
+    public CompositeBindingURIBuilderImpl(AssemblyFactory assemblyFactory,
+                                          SCABindingFactory scaBindingFactory,
+                                          InterfaceContractMapper interfaceContractMapper) {
+        super(assemblyFactory, scaBindingFactory,
+              null, null,
+              interfaceContractMapper);
+    }
+
+    public CompositeBindingURIBuilderImpl(AssemblyFactory assemblyFactory,
+                                          SCABindingFactory scaBindingFactory,
+                                          DocumentBuilderFactory documentBuilderFactory,
+                                          TransformerFactory transformerFactory,
+                                          InterfaceContractMapper interfaceContractMapper) {
+        super(assemblyFactory, scaBindingFactory,
+              documentBuilderFactory, transformerFactory, interfaceContractMapper);
+    }
+
+    public String getID() {
+        return "org.apache.tuscany.sca.assembly.builder.CompositeBindingURIBuilder";
+    }
+
+    public void build(Composite composite, Definitions definitions, Monitor monitor) throws CompositeBuilderException {
+        configureBindingURIsAndNames(composite, definitions, monitor);
+    }
+    
+    /**
+     * Called by CompositeBindingURIBuilderImpl
+     *  
+     * @param composite the composite to be configured
+     */
+    protected void configureBindingURIsAndNames(Composite composite, Definitions definitions, Monitor monitor) throws CompositeBuilderException {
+        configureBindingURIs(composite, null, definitions, null, monitor);
+        configureBindingNames(composite, monitor);
+    }
+
+    /**
+     * Fully resolve the binding URIs based on available information. This includes information
+     * from the ".composite" files, from resources associated with the binding, e.g. WSDL files, 
+     * from any associated policies and from the default information for each binding type.
+     *  
+     * @param composite the composite to be configured
+     * @param defaultBindings list of default binding configurations
+     */
+    protected void configureBindingURIs(Composite composite,
+                                        Definitions definitions, List<Binding> defaultBindings,
+                                        Monitor monitor) throws CompositeBuilderException {
+        configureBindingURIs(composite, null, definitions, defaultBindings, monitor);
+    }
+       
+     /**
+      * Fully resolve the binding URIs based on available information. This includes information
+      * from the ".composite" files, from resources associated with the binding, e.g. WSDL files, 
+      * from any associated policies and from the default information for each binding type.
+      * 
+      * NOTE: This method repeats some of the processing performed by the configureComponents()
+      *       method above.  The duplication is needed because NodeConfigurationServiceImpl
+      *       calls this method without previously calling configureComponents().  In the
+      *       normal builder sequence used by CompositeBuilderImpl, both of these methods
+      *       are called.
+      *
+      * TODO: Share the URL calculation algorithm with the configureComponents() method above
+      *       although keeping the configureComponents() methods signature as is because when
+      *       a composite is actually build in a node the node default information is currently
+      *       available
+      *  
+      * @param composite the composite to be configured
+      * @param uri the path to the composite provided through any nested composite component implementations
+      * @param defaultBindings list of default binding configurations
+      */
+    private void configureBindingURIs(Composite composite, String uri,
+                                      Definitions definitions, List<Binding> defaultBindings,
+                                      Monitor monitor) throws CompositeBuilderException {
+        
+        String parentComponentURI = uri;
+        
+        // Process nested composites recursively
+        for (Component component : composite.getComponents()) {
+
+            // Initialize component URI
+            String componentURI;
+            if (parentComponentURI == null) {
+                componentURI = component.getName();
+            } else {
+                componentURI = URI.create(parentComponentURI + '/').resolve(component.getName()).toString();
+            }
+            component.setURI(componentURI);
+
+            Implementation implementation = component.getImplementation();
+            if (implementation instanceof Composite) {
+
+                // Process nested composite
+                configureBindingURIs((Composite)implementation, componentURI, definitions, defaultBindings, monitor);
+            }
+        }  
+        
+        // Initialize composite service binding URIs
+        List<Service> compositeServices = composite.getServices();
+        for (Service service : compositeServices) {
+            // Set default binding names 
+            
+            // Create default SCA binding
+            if (service.getBindings().isEmpty()) {
+                SCABinding scaBinding = createSCABinding(definitions);
+                service.getBindings().add(scaBinding);
+            }
+    
+            // Initialize binding names and URIs
+            for (Binding binding : service.getBindings()) {  
+                constructBindingName(service, binding, monitor);
+                constructBindingURI(parentComponentURI, composite, service, binding, defaultBindings, monitor);
+            }
+        }
+        
+        // Initialize component service binding URIs
+        for (Component component : composite.getComponents()) {
+            
+            // Index properties, services and references
+            Map<String, Service> services = new HashMap<String, Service>();
+            Map<String, Reference> references = new HashMap<String, Reference>();
+            Map<String, Property> properties = new HashMap<String, Property>();
+            indexImplementationPropertiesServicesAndReferences(component,
+                                                               services,
+                                                               references,
+                                                               properties,
+                                                               monitor);
+
+            // Index component services, references and properties
+            // Also check for duplicates
+            Map<String, ComponentService> componentServices =
+                new HashMap<String, ComponentService>();
+            Map<String, ComponentReference> componentReferences =
+                new HashMap<String, ComponentReference>();
+            Map<String, ComponentProperty> componentProperties =
+                new HashMap<String, ComponentProperty>();
+            indexComponentPropertiesServicesAndReferences(component,
+                                                          componentServices,
+                                                          componentReferences,
+                                                          componentProperties,
+                                                          monitor);
+
+            // Reconcile component services/references/properties and
+            // implementation services/references and create component
+            // services/references/properties for the services/references
+            // declared by the implementation
+            reconcileServices(component, services, componentServices, monitor);
+            reconcileReferences(component, references, componentReferences, monitor);
+            reconcileProperties(component, properties, componentProperties, monitor);
+            
+            for (ComponentService service : component.getServices()) {
+    
+                // Create default SCA binding
+                if (service.getBindings().isEmpty()) {
+                    SCABinding scaBinding = createSCABinding(definitions);
+                    service.getBindings().add(scaBinding);
+                }
+    
+                // Initialize binding names and URIs
+                for (Binding binding : service.getBindings()) {
+                    
+                    constructBindingName(service, binding, monitor);
+                    constructBindingURI(component, service, binding, defaultBindings, monitor);
+                }
+            } 
+        }
+    }
+
+    /**
+     * Add default names for callback bindings and reference bindings.  Needs to be
+     * separate from configureBindingURIs() because configureBindingURIs() is called
+     * by NodeConfigurationServiceImpl as well as by CompositeBuilderImpl.
+     */
+    private void configureBindingNames(Composite composite, Monitor monitor) {
+        
+        // Process nested composites recursively
+        for (Component component : composite.getComponents()) {
+
+            Implementation implementation = component.getImplementation();
+            if (implementation instanceof Composite) {
+
+                // Process nested composite
+                configureBindingNames((Composite)implementation, monitor);
+            }
+        }  
+        
+        // Initialize composite service callback binding names
+        for (Service service : composite.getServices()) {
+
+            if (service.getCallback() != null) {
+                for (Binding binding : service.getCallback().getBindings()) {
+                    constructBindingName(service, binding, monitor);
+                }
+            }
+        }
+        
+        // Initialize composite reference binding names
+        for (Reference reference : composite.getReferences()) {
+
+            for (Binding binding : reference.getBindings()) {  
+                constructBindingName(reference, binding, monitor);
+            }
+
+            if (reference.getCallback() != null) {
+                for (Binding binding : reference.getCallback().getBindings()) {
+                    constructBindingName(reference, binding, monitor);
+                }
+            }
+        }
+        
+        // Initialize component service and reference binding names
+        for (Component component : composite.getComponents()) {
+
+            // Initialize component service callback binding names
+            for (ComponentService service : component.getServices()) {
+
+                if (service.getCallback() != null) {
+                    for (Binding binding : service.getCallback().getBindings()) {
+                        constructBindingName(service, binding, monitor);
+                    }
+                }
+            } 
+        
+            // Initialize component reference binding names
+            for (ComponentReference reference : component.getReferences()) {
+
+                // Initialize binding names
+                for (Binding binding : reference.getBindings()) {  
+                    constructBindingName(reference, binding, monitor);
+                }
+
+                if (reference.getCallback() != null) {
+                    for (Binding binding : reference.getCallback().getBindings()) {
+                        constructBindingName(reference, binding, monitor);
+                    }
+                }
+            }
+        }
+    }
+    
+    /**
+     * If a binding name is not provided by the user, construct it based on the service
+     * or reference name
+     * 
+     * @param contract the service or reference
+     * @param binding
+     */
+    private void constructBindingName(Contract contract, Binding binding, Monitor monitor) {
+        
+        // set the default binding name if one is required        
+        // if there is no name on the binding then set it to the service or reference name 
+        if (binding.getName() == null){
+            binding.setName(contract.getName());
+        }
+            
+        // Check that multiple bindings do not have the same name
+        for (Binding otherBinding : contract.getBindings()) {
+            if (otherBinding == binding) {
+                // Skip the current binding
+                continue;
+            }
+            if (binding.getClass() != otherBinding.getClass()) {
+                // Look for a binding of the same type
+                continue;
+            }
+            if (binding.getName().equals(otherBinding.getName())) {
+                warning(monitor, contract instanceof Service ? "MultipleBindingsForService" : "MultipleBindingsForReference",
+                        binding, contract.getName(), binding.getName());
+            }
+        }
+    }
+
+    /**
+     * URI construction for composite bindings based on Assembly Specification section 1.7.2, This method
+     * assumes that the component URI part of the binding URI is formed from the part to the 
+     * composite in question and just calls the generic constructBindingURI method with this 
+     * information
+     * 
+     * @param parentComponentURI
+     * @param composite
+     * @param service
+     * @param binding
+     * @param defaultBindings
+     */
+    private void constructBindingURI(String parentComponentURI, Composite composite, Service service,
+                                     Binding binding, List<Binding> defaultBindings, Monitor monitor) 
+    throws CompositeBuilderException{
+        // This is a composite service so there is no component to provide a component URI
+        // The path to this composite (through nested composites) is used.
+        boolean includeBindingName = composite.getServices().size() != 1;
+        constructBindingURI(parentComponentURI, service, binding, includeBindingName, defaultBindings, monitor);
+    }
+
+     /**
+      * URI construction for component bindings based on Assembly Specification section 1.7.2. This method
+      * calculates the component URI part based on component information before calling the generic
+      * constructBindingURI method
+      *
+      * @param component the component that holds the service
+      * @param service the service that holds the binding
+      * @param binding the binding for which the URI is being constructed
+      * @param defaultBindings the list of default binding configurations
+      */
+    private void constructBindingURI(Component component, Service service,
+                                     Binding binding, List<Binding> defaultBindings, Monitor monitor)
+        throws CompositeBuilderException{
+        boolean includeBindingName = component.getServices().size() != 1;
+        constructBindingURI(component.getURI(), service, binding, includeBindingName, defaultBindings, monitor);
+    }
+            
+    /**
+     * Generic URI construction for bindings based on Assembly Specification section 1.7.2
+     * 
+     * @param componentURIString the string version of the URI part that comes from the component name
+     * @param service the service in question
+     * @param binding the binding for which the URI is being constructed
+     * @param includeBindingName when set true the serviceBindingURI part should be used
+     * @param defaultBindings the list of default binding configurations
+     * @throws CompositeBuilderException
+     */
+    private void constructBindingURI(String componentURIString, Service service, Binding binding,
+                                     boolean includeBindingName, List<Binding> defaultBindings, Monitor monitor) 
+        throws CompositeBuilderException{
+        
+        try {
+            // calculate the service binding URI
+            URI bindingURI;
+            if (binding.getURI() != null){
+                bindingURI = new URI(binding.getURI());
+
+                // if the user has provided an absolute binding URI then use it
+                if (bindingURI.isAbsolute()){
+                    binding.setURI(bindingURI.toString());
+                    return;
+                }
+            } else {
+                bindingURI = null;
+            }
+            
+            // Get the service binding name
+            URI bindingName;
+            if (binding.getName() != null) {
+                bindingName = new URI(binding.getName());
+            } else {
+                bindingName = new URI("");
+            }
+            
+            // calculate the component URI  
+            URI componentURI;
+            if (componentURIString != null) {
+                componentURI = new URI(addSlashToPath(componentURIString));
+            } else {
+                componentURI = null;
+            }
+            
+            // if the user has provided an absolute component URI then use it
+            if (componentURI != null && componentURI.isAbsolute()){
+                binding.setURI(constructBindingURI(null, componentURI, bindingURI, includeBindingName, bindingName));
+                return;
+            }         
+            
+            // calculate the base URI
+            URI baseURI = null;
+            if (defaultBindings != null) {
+                for (Binding defaultBinding : defaultBindings){
+                    if (binding.getClass() == defaultBinding.getClass()){
+                        baseURI = new URI(addSlashToPath(defaultBinding.getURI()));
+                        break;
+                    }
+                }
+            }
+            
+            binding.setURI(constructBindingURI(baseURI, componentURI, bindingURI, includeBindingName, bindingName));
+        } catch (URISyntaxException ex) {
+            error(monitor, "URLSyntaxException", binding, componentURIString, service.getName(), binding.getName());
+        }      
+    }
+    
+    /**
+     * Use to ensure that URI paths end in "/" as here we want to maintain the
+     * last path element of an base URI when other URI are resolved against it. This is
+     * not the default behaviour of URI resolution as defined in RFC 2369
+     * 
+     * @param path the path string to which the "/" is to be added
+     * @return the resulting path with a "/" added if it not already there
+     */
+    private static String addSlashToPath(String path){
+        if (path.endsWith("/") || path.endsWith("#")){
+            return path;
+        } else {
+            return path + "/";
+        }
+    }
+    
+    /**
+     * Concatenate binding URI parts together based on Assembly Specification section 1.7.2
+     * 
+     * @param baseURI the base of the binding URI
+     * @param componentURI the middle part of the binding URI derived from the component name
+     * @param bindingURI the end part of the binding URI
+     * @param includeBindingName when set true the binding name part should be used
+     * @param bindingName the binding name
+     * @return the resulting URI as a string
+     */
+    private static String constructBindingURI(URI baseURI, URI componentURI, URI bindingURI, boolean includeBindingName, URI bindingName){        
+        String uriString;
+        
+        if (baseURI == null) {
+            if (componentURI == null){
+                if (bindingURI != null ) {
+                    uriString = bindingURI.toString();
+                } else {
+                    uriString = bindingName.toString();
+                }
+            } else {
+                if (bindingURI != null ) {
+                    uriString = componentURI.resolve(bindingURI).toString();
+                } else {
+                    if (includeBindingName) {
+                        uriString = componentURI.resolve(bindingName).toString();
+                    } else {
+                        uriString = componentURI.toString();
+                    }
+                }
+            }
+        } else {
+            if (componentURI == null) {
+                if (bindingURI != null ) {
+                    uriString = basedURI(baseURI, bindingURI).toString();
+                } else {
+                    if (includeBindingName) {
+                        uriString = basedURI(baseURI, bindingName).toString();
+                    } else {
+                        uriString = baseURI.toString();
+                    }
+                }
+            } else {
+                if (bindingURI != null ) {
+                    uriString = basedURI(baseURI, componentURI.resolve(bindingURI)).toString();
+                } else {
+                    if (includeBindingName) {
+                        uriString = basedURI(baseURI, componentURI.resolve(bindingName)).toString();
+                    } else {
+                        uriString = basedURI(baseURI, componentURI).toString();
+                    }
+                }
+            }
+        }
+        
+        // tidy up by removing any trailing "/"
+        if (uriString.endsWith("/")){
+            uriString = uriString.substring(0, uriString.length()-1);   
+        }
+        
+        URI uri = URI.create(uriString);
+        if (!uri.isAbsolute()) {
+            uri = URI.create("/").resolve(uri);
+        }
+        return uri.toString();
+    }
+
+    /**
+     * Combine a URI with a base URI.
+     * 
+     * @param baseURI
+     * @param uri
+     * @return
+     */
+    private static URI basedURI(URI baseURI, URI uri) {
+        if (uri.getScheme() != null) {
+            return uri;
+        }
+        String str = uri.toString();
+        if (str.startsWith("/")) {
+            str = str.substring(1);
+        }
+        return URI.create(baseURI.toString() + str).normalize();
+    }    
+    
+}