2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.config.persist.storage.file.xml.model;
10 import com.google.common.base.Charsets;
11 import com.google.common.base.Optional;
12 import com.google.common.collect.Iterables;
13 import com.google.common.collect.Lists;
14 import com.google.common.io.Files;
16 import java.io.IOException;
17 import java.util.List;
18 import javax.xml.bind.JAXBContext;
19 import javax.xml.bind.JAXBException;
20 import javax.xml.bind.Marshaller;
21 import javax.xml.bind.Unmarshaller;
22 import javax.xml.bind.annotation.XmlElement;
23 import javax.xml.bind.annotation.XmlElementWrapper;
24 import javax.xml.bind.annotation.XmlRootElement;
25 import javax.xml.stream.XMLInputFactory;
26 import javax.xml.stream.XMLStreamException;
27 import javax.xml.stream.XMLStreamReader;
28 import javax.xml.transform.stream.StreamSource;
29 import org.apache.commons.lang3.StringUtils;
31 @XmlRootElement(name = "persisted-snapshots")
32 public final class Config {
34 private List<ConfigSnapshot> snapshots;
36 Config(List<ConfigSnapshot> snapshots) {
37 this.snapshots = snapshots;
41 this.snapshots = Lists.newArrayList();
44 @XmlElement(name = "snapshot")
45 @XmlElementWrapper(name = "snapshots")
46 public List<ConfigSnapshot> getSnapshots() {
50 public void setSnapshots(List<ConfigSnapshot> snapshots) {
51 this.snapshots = snapshots;
54 public void toXml(File to) {
57 // TODO Moxy has to be used instead of default jaxb impl due to a bug
58 // default implementation has a bug that prevents from serializing xml in a string
59 JAXBContext jaxbContext = org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(new Class[]{Config.class}, null);
61 Marshaller marshaller = jaxbContext.createMarshaller();
63 marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
65 marshaller.marshal(this, to);
66 } catch (JAXBException e) {
67 throw new PersistException("Unable to persist configuration", e);
71 public static Config fromXml(File from) {
77 JAXBContext jaxbContext = JAXBContext.newInstance(Config.class);
78 Unmarshaller um = jaxbContext.createUnmarshaller();
79 XMLInputFactory xif = XMLInputFactory.newFactory();
80 xif.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false);
81 xif.setProperty(XMLInputFactory.SUPPORT_DTD, false);
82 XMLStreamReader xsr = xif.createXMLStreamReader(new StreamSource(from));
83 return ((Config) um.unmarshal(xsr));
84 } catch (JAXBException | XMLStreamException e) {
85 throw new PersistException("Unable to restore configuration", e);
89 private static boolean isEmpty(File from) {
90 return from.length() == 0 || isBlank(from);
93 private static boolean isBlank(File from) {
95 return StringUtils.isBlank(Files.toString(from, Charsets.UTF_8));
96 } catch (IOException e) {
97 throw new IllegalStateException("Unexpected error reading file" + from, e);
101 public Optional<ConfigSnapshot> getLastSnapshot() {
102 ConfigSnapshot last = Iterables.getLast(snapshots, null);
103 return last == null ? Optional.<ConfigSnapshot>absent() : Optional.of(last);
106 public void addConfigSnapshot(ConfigSnapshot snap, int numberOfStoredBackups) {
107 if(shouldReplaceLast(numberOfStoredBackups) && snapshots.isEmpty() == false) {
113 private boolean shouldReplaceLast(int numberOfStoredBackups) {
114 return numberOfStoredBackups == snapshots.size();