org.apache.tuscany.sca.definitions.xml.DefaultDefinitionsExtensionPoint Maven / Gradle / Ivy

/*
 * 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.definitions.xml;

import java.io.IOException;
import java.net.URI;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.apache.tuscany.sca.contribution.processor.ContributionReadException;
import org.apache.tuscany.sca.contribution.processor.ProcessorContext;
import org.apache.tuscany.sca.contribution.processor.URLArtifactProcessor;
import org.apache.tuscany.sca.contribution.processor.URLArtifactProcessorExtensionPoint;
import org.apache.tuscany.sca.core.ExtensionPointRegistry;
import org.apache.tuscany.sca.core.UtilityExtensionPoint;
import org.apache.tuscany.sca.definitions.Definitions;
import org.apache.tuscany.sca.extensibility.ServiceDeclaration;
import org.apache.tuscany.sca.monitor.MonitorFactory;

/**
 * Default implementation of an extension point for XML definitionss.
 *
 * @version $Rev: 1350968 $ $Date: 2012-06-16 19:13:24 +0100 (Sat, 16 Jun 2012) $
 */
public class DefaultDefinitionsExtensionPoint implements DefinitionsExtensionPoint {
    private static final Logger logger = Logger.getLogger(DefaultDefinitionsExtensionPoint.class.getName());
    private static final URI DEFINITIONS_URI = URI.create("META-INF/definitions.xml");
    private ExtensionPointRegistry registry;
    private MonitorFactory monitorFactory;
    private Set documents = new HashSet();
    private List definitions = new ArrayList();
    private boolean documentsLoaded;
    private boolean loaded;

    public DefaultDefinitionsExtensionPoint(ExtensionPointRegistry registry) {
        this.registry = registry;
        this.monitorFactory = registry.getExtensionPoint(UtilityExtensionPoint.class).getUtility(MonitorFactory.class);
    }

    public void addDefinitionsDocument(URL url) {
        documents.add(url);
    }

    public void removeDefinitionsDocument(URL url) {
        documents.remove(url);
    }

    /**
     * Load definitions declarations from META-INF/services/
     * org.apache.tuscany.sca.contribution.processor.Definitions files
     */
    private synchronized void loadDefinitionsDocuments() {
        if (documentsLoaded)
            return;

        // Get the definitions declarations
        Collection definitionsDeclarations;
        try {
            // Get definitions declarations in ranking order.
            definitionsDeclarations = registry.getServiceDiscovery().getServiceDeclarations(DEFINITIONS_FILE, true);
        } catch (IOException e) {
            throw new IllegalStateException(e);
        }

        // Find each definitions
        Set definitionResources = new HashSet();
        for (ServiceDeclaration definitionsDeclaration : definitionsDeclarations) {
            // Only process the first instance of a given resource name.
            // This allows definitions files to be overridden by an embedder. 
            String resourceName = definitionsDeclaration.getClassName();
            if (!definitionResources.contains(resourceName)) {
                definitionResources.add(resourceName);
                URL url = definitionsDeclaration.getResource(resourceName);
                if (url == null) {
                    throw new IllegalArgumentException(definitionsDeclaration.getClassName() + " cannot be found");
                }
                documents.add(url);
            }
        }

        documentsLoaded = true;
    }

    public synchronized List getDefinitions() {
        if (!loaded) {
            loadDefinitionsDocuments();
            URLArtifactProcessorExtensionPoint processors =
                registry.getExtensionPoint(URLArtifactProcessorExtensionPoint.class);
            URLArtifactProcessor processor = processors.getProcessor(Definitions.class);
            ProcessorContext context = new ProcessorContext(monitorFactory.createMonitor());
            for (URL url : documents) {
                Definitions def;
                try {
                    def = processor.read(null, DEFINITIONS_URI, url, context);
                    definitions.add(def);
                } catch (ContributionReadException e) {
                    logger.log(Level.SEVERE, e.getMessage(), e);
                }
            }
            loaded = true;
        }
        return definitions;
    }

    public void addDefinitions(Definitions def) {
        this.definitions.add(def);
    }

    public void removeDefinitions(Definitions def) {
        this.definitions.remove(def);
    }
}