org.apache.karaf.tooling.features.FeatureMetaDataExporter 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.karaf.tooling.features;

import java.io.OutputStream;

import javax.xml.stream.XMLEventFactory;
import javax.xml.stream.XMLEventWriter;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.StartDocument;

import org.apache.karaf.tooling.features.model.BundleRef;
import org.apache.karaf.tooling.features.model.ArtifactRef;
import org.apache.karaf.tooling.features.model.Feature;
import org.apache.maven.artifact.Artifact;

/**
 * Export feature meta data as xml into a stream
 */
public class FeatureMetaDataExporter {

    private XMLEventWriter writer;
    private XMLEventFactory factory;

    public FeatureMetaDataExporter(OutputStream out) throws XMLStreamException {
        XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
        writer = outputFactory.createXMLEventWriter(out);
        factory = XMLEventFactory.newInstance();
        StartDocument startDocument = factory.createStartDocument();
        writer.add(startDocument);
        newLine();
        writer.add(factory.createStartElement("", "", "features"));
        newLine();
    }

    public void writeFeature(Feature feature) throws XMLStreamException {
        writeFeatureTag(feature);
        for (String featureDep : feature.getDependencies()) {
            writer.add(factory.createStartElement("", "", "feature"));
            writer.add(factory.createCharacters(featureDep));
            endElement("feature");
        }
        for (BundleRef bundle : feature.getBundles()) {
            writer.add(factory.createStartElement("", "", "bundle"));
            if (bundle.getStartLevel() != null) {
                writer.add(factory.createAttribute("start-level", bundle.getStartLevel().toString()));
            }
            if (bundle.getArtifact()!=null) {
                String name = MavenUtil.getFileName(bundle.getArtifact());
                writer.add(factory.createAttribute("name", name));
                Artifact artifact = bundle.getArtifact();
                bundle.readManifest();
                if (bundle.getBundleSymbolicName() != null) {
                    String[] results = bundle.getBundleSymbolicName().split(";");
                    writer.add(factory.createAttribute("Bundle-SymbolicName", results[0]));
                    writer.add(factory.createAttribute("Bundle-Version", bundle.getBundleVersion()));
                }
                writer.add(factory.createAttribute("groupId", artifact.getGroupId()));
                writer.add(factory.createAttribute("artifactId", artifact.getArtifactId()));
                if (artifact.getType() != null) {
                    writer.add(factory.createAttribute("type", artifact.getType()));
                }
                if (artifact.getClassifier() != null) {
                    writer.add(factory.createAttribute("classifier", artifact.getClassifier()));
                }
                writer.add(factory.createAttribute("version", artifact.getBaseVersion()));
            }

            writer.add(factory.createCharacters(bundle.getUrl()));
            endElement("bundle");
        }
        for (ArtifactRef config : feature.getConfigFiles()) {
            writer.add(factory.createStartElement("", "", "config"));
            if (config.getArtifact()!= null) {
                String name = MavenUtil.getFileName(config.getArtifact());
                writer.add(factory.createAttribute("name", name));
                Artifact artifact = config.getArtifact();
                writer.add(factory.createAttribute("groupId", artifact.getGroupId()));
                writer.add(factory.createAttribute("artifactId", artifact.getArtifactId()));
                if (artifact.getType() != null) {
                    writer.add(factory.createAttribute("type", artifact.getType()));
                }
                if (artifact.getClassifier() != null) {
                    writer.add(factory.createAttribute("classifier", artifact.getClassifier()));
                }
                writer.add(factory.createAttribute("version", artifact.getBaseVersion()));
            }
            writer.add(factory.createCharacters(config.getUrl()));
            endElement("config");
        }
        endElement("feature");
    }

    private void writeFeatureTag(Feature feature) throws XMLStreamException {
        writer.add(factory.createStartElement("", "", "feature"));
        writer.add(factory.createAttribute("name", feature.getName()));
        if (feature.getVersion() != null) {
            writer.add(factory.createAttribute("version", feature.getVersion()));
        }
        newLine();
    }

    public void close() throws XMLStreamException {
        endElement("features");
        writer.add(factory.createEndDocument());
        writer.close();
    }
    

    private void endElement(String elementName) throws XMLStreamException {
        writer.add(factory.createEndElement("", "", elementName));
        newLine();
    }

    private void newLine() throws XMLStreamException {
        writer.add(factory.createCharacters("\r\n"));
    }

}