opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryPersister.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.config.persist.storage.directory.xml;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.base.Optional;
  13 import com.google.common.io.Files;
  14 import java.io.File;
  15 import java.io.FilenameFilter;
  16 import java.io.IOException;
  17 import java.util.ArrayList;
  18 import java.util.Arrays;
  19 import java.util.Collections;
  20 import java.util.List;
  21 import java.util.Set;
  22 import java.util.SortedSet;
  23 import javax.xml.bind.JAXBContext;
  24 import javax.xml.bind.JAXBException;
  25 import javax.xml.bind.Unmarshaller;
  26 import org.opendaylight.controller.config.persist.api.ConfigSnapshotHolder;
  27 import org.opendaylight.controller.config.persist.api.Persister;
  28 import org.opendaylight.controller.config.persist.storage.file.xml.model.ConfigSnapshot;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 public class XmlDirectoryPersister implements Persister {
  33     private static final Logger LOG = LoggerFactory.getLogger(XmlDirectoryPersister.class);
  34
  35     private final File storage;
  36     private final Optional<FilenameFilter> extensionsFilter;
  37
  38     /**
  39      * Creates XmlDirectoryPersister that picks up all files in specified folder
  40      */
  41     public XmlDirectoryPersister(final File storage) {
  42         this(storage, Optional.<FilenameFilter>absent());
  43     }
  44
  45     /**
  46      * Creates XmlDirectoryPersister that picks up files only with specified file extension
  47      */
  48     public XmlDirectoryPersister(final File storage, final Set<String> fileExtensions) {
  49         this(storage, Optional.of(getFilter(fileExtensions)));
  50     }
  51
  52     private XmlDirectoryPersister(final File storage, final Optional<FilenameFilter> extensionsFilter) {
  53         checkArgument(storage.exists() && storage.isDirectory(), "Storage directory does not exist: " + storage);
  54         this.storage = storage;
  55         this.extensionsFilter = extensionsFilter;
  56     }
  57
  58     @Override
  59     public void persistConfig(final ConfigSnapshotHolder holder) throws IOException {
  60         throw new UnsupportedOperationException("This adapter is read only. Please set readonly=true on " + getClass());
  61     }
  62
  63     @Override
  64     public List<ConfigSnapshotHolder> loadLastConfigs() throws IOException {
  65         File[] filesArray = extensionsFilter.isPresent() ? storage.listFiles(extensionsFilter.get()) : storage.listFiles();
  66         if (filesArray == null || filesArray.length == 0) {
  67             return Collections.emptyList();
  68         }
  69         List<File> sortedFiles = new ArrayList<>(Arrays.asList(filesArray));
  70         Collections.sort(sortedFiles);
  71         // combine all found files
  72         LOG.debug("Reading files in following order: {}", sortedFiles);
  73
  74         List<ConfigSnapshotHolder> result = new ArrayList<>();
  75         for (File file : sortedFiles) {
  76             LOG.trace("Adding file '{}' to combined result", file);
  77             Optional<ConfigSnapshotHolder> h = fromXmlSnapshot(file);
  78             // Ignore non valid snapshot
  79             if(h.isPresent() == false) {
  80                 continue;
  81             }
  82
  83             result.add(h.get());
  84         }
  85         return result;
  86     }
  87
  88     private Optional<ConfigSnapshotHolder> fromXmlSnapshot(final File file) {
  89         try {
  90             return Optional.of(loadLastConfig(file));
  91         } catch (JAXBException e) {
  92             // In case of parse error, issue a warning, ignore and continue
  93             LOG.warn(
  94                     "Unable to parse configuration snapshot from {}. Initial config from {} will be IGNORED in this run. ",
  95                     file, file);
  96             LOG.warn(
  97                     "Note that subsequent config files may fail due to this problem. ",
  98                     "Xml markup in this file needs to be fixed, for detailed information see enclosed exception.",
  99                     e);
 100         }
 101
 102         return Optional.absent();
 103     }
 104
 105     public static ConfigSnapshotHolder loadLastConfig(final File file) throws JAXBException {
 106         JAXBContext jaxbContext = JAXBContext.newInstance(ConfigSnapshot.class);
 107         Unmarshaller um = jaxbContext.createUnmarshaller();
 108
 109         return asHolder((ConfigSnapshot) um.unmarshal(file));
 110     }
 111
 112     private static ConfigSnapshotHolder asHolder(final ConfigSnapshot unmarshalled) {
 113         return new ConfigSnapshotHolder() {
 114             @Override
 115             public String getConfigSnapshot() {
 116                 return unmarshalled.getConfigSnapshot();
 117             }
 118
 119             @Override
 120             public SortedSet<String> getCapabilities() {
 121                 return unmarshalled.getCapabilities();
 122             }
 123
 124             @Override
 125             public String toString() {
 126                 return unmarshalled.toString();
 127             }
 128         };
 129     }
 130
 131     private static FilenameFilter getFilter(final Set<String>fileExtensions) {
 132         checkArgument(fileExtensions.isEmpty() == false, "No file extension provided", fileExtensions);
 133
 134         return new FilenameFilter() {
 135             @Override
 136             public boolean accept(final File dir, final String name) {
 137                 String ext = Files.getFileExtension(name);
 138                 return fileExtensions.contains(ext);
 139             }
 140         };
 141     }
 142
 143     @Override
 144     public void close() {
 145
 146     }
 147
 148     @Override
 149     public String toString() {
 150         final StringBuffer sb = new StringBuffer("XmlDirectoryPersister{");
 151         sb.append("storage=").append(storage);
 152         sb.append('}');
 153         return sb.toString();
 154     }
 155 }