X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fconfig%2Fconfig-persister-feature-adapter%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fconfigpusherfeature%2Finternal%2FAbstractFeatureWrapper.java;h=eec788252932435afe4b4607968364a78ac33028;hp=d18928d06c1f09ac9dd3af62846a8bcf9b08a07d;hb=8b1ea7f69a0183c988d3861a8b6c90e465d687ae;hpb=cd5b4bd47e1cfc40751ef15f6fcdf33fc131c1f8 diff --git a/opendaylight/config/config-persister-feature-adapter/src/main/java/org/opendaylight/controller/configpusherfeature/internal/AbstractFeatureWrapper.java b/opendaylight/config/config-persister-feature-adapter/src/main/java/org/opendaylight/controller/configpusherfeature/internal/AbstractFeatureWrapper.java index d18928d06c..eec7882529 100644 --- a/opendaylight/config/config-persister-feature-adapter/src/main/java/org/opendaylight/controller/configpusherfeature/internal/AbstractFeatureWrapper.java +++ b/opendaylight/config/config-persister-feature-adapter/src/main/java/org/opendaylight/controller/configpusherfeature/internal/AbstractFeatureWrapper.java @@ -7,18 +7,27 @@ */ package org.opendaylight.controller.configpusherfeature.internal; +import com.google.common.base.Optional; import com.google.common.base.Preconditions; +import com.google.common.io.Files; +import java.io.File; +import java.io.FileInputStream; import java.util.LinkedHashSet; import java.util.List; +import java.util.Set; import javax.xml.bind.JAXBException; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.stream.XMLStreamException; import org.apache.karaf.features.BundleInfo; import org.apache.karaf.features.Conditional; import org.apache.karaf.features.ConfigFileInfo; import org.apache.karaf.features.ConfigInfo; import org.apache.karaf.features.Dependency; import org.apache.karaf.features.Feature; +import org.opendaylight.controller.config.persist.storage.file.xml.model.ConfigSnapshot; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.w3c.dom.Element; /* * Wrap a Feature for the purposes of extracting the FeatureConfigSnapshotHolders from @@ -28,6 +37,9 @@ import org.slf4j.LoggerFactory; */ public class AbstractFeatureWrapper implements Feature { private static final Logger LOG = LoggerFactory.getLogger(AbstractFeatureWrapper.class); + + protected static final String CONFIG_FILE_SUFFIX = "xml"; + protected Feature feature = null; protected AbstractFeatureWrapper() { @@ -46,23 +58,69 @@ public class AbstractFeatureWrapper implements Feature { * Get FeatureConfigSnapshotHolders appropriate to feed to the config subsystem * from the underlying Feature Config files */ - public LinkedHashSet getFeatureConfigSnapshotHolders() throws Exception { - final LinkedHashSet snapShotHolders = new LinkedHashSet(); + public Set getFeatureConfigSnapshotHolders() throws Exception { + final Set snapShotHolders = new LinkedHashSet<>(); for(final ConfigFileInfo c: getConfigurationFiles()) { - try { - snapShotHolders.add(new FeatureConfigSnapshotHolder(c,this)); - } catch (final JAXBException e) { - LOG.debug("{} is not a config subsystem config file",c.getFinalname()); + // Skip non config snapshot XML files + if(isConfigSnapshot(c.getFinalname())) { + final Optional featureConfigSnapshotHolder = getFeatureConfigSnapshotHolder(c); + if(featureConfigSnapshotHolder.isPresent()) { + snapShotHolders.add(featureConfigSnapshotHolder.get()); + } } } return snapShotHolders; } + protected Optional getFeatureConfigSnapshotHolder(final ConfigFileInfo c) { + try { + return Optional.of(new FeatureConfigSnapshotHolder(c, this)); + } catch (final JAXBException e) { + LOG.warn("Unable to parse configuration snapshot. Config from '{}' will be IGNORED. " + + "Note that subsequent config files may fail due to this problem. " + + "Xml markup in this file needs to be fixed, for detailed information see enclosed exception.", + c.getFinalname(), e); + } catch (final XMLStreamException e) { + // Files that cannot be loaded are ignored as non config subsystem files e.g. jetty.xml + LOG.debug("Unable to read configuration file '{}'. Not a configuration snapshot", + c.getFinalname(), e); + } + return Optional.absent(); + } + + private static boolean isConfigSnapshot(String fileName) { + if(!Files.getFileExtension(fileName).equals(CONFIG_FILE_SUFFIX)) { + return false; + } + + if(fileName.endsWith("jetty.xml")) { + // Special case - ignore the jetty.xml file as it contains a DTD and causes a "Connection refused" + // error when it tries to go out to the network to retrieve it. We don't want it trying to go out + // to the network nor do we want an error logged trying to parse it. + return false; + } + + File file = new File(System.getProperty("karaf.home"), fileName); + try(FileInputStream fis = new FileInputStream(file)) { + DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance(); + builderFactory.setNamespaceAware(true); + builderFactory.setCoalescing(true); + builderFactory.setIgnoringElementContentWhitespace(true); + builderFactory.setIgnoringComments(true); + + Element root = builderFactory.newDocumentBuilder().parse(fis).getDocumentElement(); + return ConfigSnapshot.SNAPSHOT_ROOT_ELEMENT_NAME.equals(root.getLocalName()); + } catch (Exception e) { + LOG.error("Could not parse XML file {}", file, e); + return false; + } + } + @Override public int hashCode() { final int prime = 31; int result = 1; - result = prime * result + ((feature == null) ? 0 : feature.hashCode()); + result = prime * result + (feature == null ? 0 : feature.hashCode()); return result; } @@ -228,4 +286,4 @@ public class AbstractFeatureWrapper implements Feature { return feature.getRegion(); } -} \ No newline at end of file +}