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=1bf2025c46ee3af3085f77ab6fdf166a54b71846;hb=8b1ea7f69a0183c988d3861a8b6c90e465d687ae;hpb=a3ff4b68093e6d675a92159e0efa2525af32d644 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 1bf2025c46..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,21 +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.Map; - +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 com.google.common.base.Preconditions; +import org.w3c.dom.Element; /* * Wrap a Feature for the purposes of extracting the FeatureConfigSnapshotHolders from @@ -30,7 +36,10 @@ import com.google.common.base.Preconditions; * Delegates the the contained feature and provides additional methods. */ public class AbstractFeatureWrapper implements Feature { - private static final Logger logger = LoggerFactory.getLogger(AbstractFeatureWrapper.class); + private static final Logger LOG = LoggerFactory.getLogger(AbstractFeatureWrapper.class); + + protected static final String CONFIG_FILE_SUFFIX = "xml"; + protected Feature feature = null; protected AbstractFeatureWrapper() { @@ -40,7 +49,7 @@ public class AbstractFeatureWrapper implements Feature { /* * @param f Feature to wrap */ - public AbstractFeatureWrapper(Feature f) { + public AbstractFeatureWrapper(final Feature f) { Preconditions.checkNotNull(f,"FeatureWrapper requires non-null Feature in constructor"); this.feature = f; } @@ -49,40 +58,91 @@ 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 { - LinkedHashSet snapShotHolders = new LinkedHashSet(); - for(ConfigFileInfo c: getConfigurationFiles()) { - try { - snapShotHolders.add(new FeatureConfigSnapshotHolder(c,this)); - } catch (JAXBException e) { - logger.debug("{} is not a config subsystem config file",c.getFinalname()); + public Set getFeatureConfigSnapshotHolders() throws Exception { + final Set snapShotHolders = new LinkedHashSet<>(); + for(final ConfigFileInfo c: getConfigurationFiles()) { + // 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; } @Override - public boolean equals(Object obj) { - if (this == obj) + public boolean equals(final Object obj) { + if (this == obj) { return true; - if (obj == null) + } + if (obj == null) { return false; - if (getClass() != obj.getClass()) + } + if (getClass() != obj.getClass()) { return false; - AbstractFeatureWrapper other = (AbstractFeatureWrapper) obj; + } + final AbstractFeatureWrapper other = (AbstractFeatureWrapper) obj; if (feature == null) { - if (other.feature != null) + if (other.feature != null) { return false; - } else if (!feature.equals(other.feature)) + } + } else if (!feature.equals(other.feature)) { return false; + } return true; } @@ -95,6 +155,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getId() */ + @Override public String getId() { return feature.getId(); } @@ -103,6 +164,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getName() */ + @Override public String getName() { return feature.getName(); } @@ -111,6 +173,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getDescription() */ + @Override public String getDescription() { return feature.getDescription(); } @@ -119,6 +182,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getDetails() */ + @Override public String getDetails() { return feature.getDetails(); } @@ -127,6 +191,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getVersion() */ + @Override public String getVersion() { return feature.getVersion(); } @@ -135,6 +200,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#hasVersion() */ + @Override public boolean hasVersion() { return feature.hasVersion(); } @@ -143,6 +209,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getResolver() */ + @Override public String getResolver() { return feature.getResolver(); } @@ -151,6 +218,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getInstall() */ + @Override public String getInstall() { return feature.getInstall(); } @@ -159,6 +227,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getDependencies() */ + @Override public List getDependencies() { return feature.getDependencies(); } @@ -167,6 +236,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getBundles() */ + @Override public List getBundles() { return feature.getBundles(); } @@ -175,7 +245,8 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getConfigurations() */ - public Map> getConfigurations() { + @Override + public List getConfigurations() { return feature.getConfigurations(); } @@ -183,6 +254,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getConfigurationFiles() */ + @Override public List getConfigurationFiles() { return feature.getConfigurationFiles(); } @@ -191,6 +263,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getConditional() */ + @Override public List getConditional() { return feature.getConditional(); } @@ -199,6 +272,7 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getStartLevel() */ + @Override public int getStartLevel() { return feature.getStartLevel(); } @@ -207,8 +281,9 @@ public class AbstractFeatureWrapper implements Feature { * @return * @see org.apache.karaf.features.Feature#getRegion() */ + @Override public String getRegion() { return feature.getRegion(); } -} \ No newline at end of file +}