source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2020 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.ce.task.projectanalysis.util.cache;
  21
  22 import java.io.File;
  23 import java.io.FileOutputStream;
  24 import java.io.IOException;
  25 import java.io.ObjectOutputStream;
  26 import java.io.OutputStream;
  27 import java.io.Serializable;
  28 import org.apache.commons.io.FileUtils;
  29 import org.apache.commons.io.IOUtils;
  30 import org.sonar.api.utils.System2;
  31 import org.sonar.core.util.CloseableIterator;
  32
  33 /**
  34  * Serialize and deserialize objects on disk. No search capabilities, only traversal (full scan).
  35  */
  36 public class DiskCache<O extends Serializable> {
  37
  38   private final File file;
  39   private final System2 system2;
  40
  41   public DiskCache(File file, System2 system2) {
  42     this.system2 = system2;
  43     this.file = file;
  44     OutputStream output = null;
  45     boolean threw = true;
  46     try {
  47       // writes the serialization stream header required when calling "traverse()"
  48       // on empty stream. Moreover it allows to call multiple times "newAppender()"
  49       output = new ObjectOutputStream(new FileOutputStream(file));
  50       output.flush();
  51       threw = false;
  52     } catch (IOException e) {
  53       throw new IllegalStateException("Fail to write into file: " + file, e);
  54     } finally {
  55       if (threw) {
  56         // do not hide initial exception
  57         IOUtils.closeQuietly(output);
  58       } else {
  59         // raise an exception if can't close
  60         system2.close(output);
  61       }
  62     }
  63   }
  64
  65   public DiskAppender newAppender() {
  66     return new DiskAppender();
  67   }
  68
  69   public CloseableIterator<O> traverse() {
  70     try {
  71       return new ObjectInputStreamIterator<>(FileUtils.openInputStream(file));
  72     } catch (IOException e) {
  73       throw new IllegalStateException("Fail to traverse file: " + file, e);
  74     }
  75   }
  76
  77   public class DiskAppender implements AutoCloseable {
  78     private final ObjectOutputStream output;
  79
  80     private DiskAppender() {
  81       try {
  82         this.output = new ObjectOutputStream(new FileOutputStream(file, true)) {
  83           @Override
  84           protected void writeStreamHeader() {
  85             // do not write stream headers as it's already done in constructor of DiskCache
  86           }
  87         };
  88       } catch (IOException e) {
  89         throw new IllegalStateException("Fail to open file " + file, e);
  90       }
  91     }
  92
  93     public DiskAppender append(O object) {
  94       try {
  95         output.writeObject(object);
  96         output.reset();
  97         return this;
  98       } catch (IOException e) {
  99         throw new IllegalStateException("Fail to write into file " + file, e);
 100       }
 101     }
 102
 103     @Override
 104     public void close() {
 105       system2.close(output);
 106     }
 107   }
 108 }