introduce CacheException

Author: vladak

opengrok-indexer/src/main/java/org/opengrok/indexer/history/AbstractCache.java

@@ -39,12 +39,13 @@
  */
 public abstract class AbstractCache implements Cache {
 
-    public boolean hasCacheForFile(File file) throws HistoryException {
+
+
+    public boolean hasCacheForFile(File file) throws CacheException {
         try {
             return getCachedFile(file).exists();
-        } catch (ForbiddenSymlinkException ex) {
-            LOGGER.log(Level.FINER, ex.getMessage());
-            return false;
+        } catch (CacheException ex) {
+            throw new CacheException(ex);
         }
     }
 
@@ -53,8 +54,9 @@ public boolean hasCacheForFile(File file) throws HistoryException {
      *
      * @param file the file to find the cache for
      * @return file that might contain cached object for <code>file</code>
+     * @throws CacheException on error
      */
-    File getCachedFile(File file) throws HistoryException, ForbiddenSymlinkException {
+    File getCachedFile(File file) throws CacheException {
 
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
 
@@ -69,8 +71,8 @@ File getCachedFile(File file) throws HistoryException, ForbiddenSymlinkException
                 add = File.separator;
             }
             sb.append(add);
-        } catch (IOException e) {
-            throw new HistoryException("Failed to get path relative to source root for " + file, e);
+        } catch (ForbiddenSymlinkException | IOException e) {
+            throw new CacheException("Failed to get path relative to source root for " + file, e);
         }
 
         return new File(TandemPath.join(sb.toString(), ".gz"));
@@ -85,7 +87,7 @@ public List<String> clearCache(Collection<RepositoryInfo> repositories) {
                 clearedRepos.add(repo.getDirectoryNameRelative());
                 LOGGER.log(Level.INFO, "{1} cache for ''{0}'' cleared.",
                         new Object[]{repo.getDirectoryName(), this.getInfo()});
-            } catch (HistoryException e) {
+            } catch (CacheException e) {
                 LOGGER.log(Level.WARNING,
                         "Clearing cache for repository {0} failed: {1}",
                         new Object[]{repo.getDirectoryName(), e.getLocalizedMessage()});
@@ -115,11 +117,9 @@ public void clearFile(String path) {
         File historyFile;
         try {
             historyFile = getCachedFile(new File(RuntimeEnvironment.getInstance().getSourceRootPath() + path));
-        } catch (ForbiddenSymlinkException ex) {
-            LOGGER.log(Level.FINER, ex.getMessage());
-            return;
-        } catch (HistoryException ex) {
-            LOGGER.log(Level.WARNING, String.format("cannot get history file for file %s", path), ex);
+        } catch (CacheException ex) {
+            LOGGER.log(Level.WARNING, String.format("cannot get cached file for file '%s'"
+                    + " - the cache entry will not be cleared", path), ex);
             return;
         }
 

opengrok-indexer/src/main/java/org/opengrok/indexer/history/AnnotationCache.java

@@ -27,28 +27,23 @@
 import java.io.File;
 
 public interface AnnotationCache extends Cache {
-    /**
-     * Perform whatever initialization is needed for given cache implementation.
-     */
-    void initialize();
-
     /**
      * Retrieve annotation from cache.
      * @param file file under source root to get the annotation for
      * @param rev requested revision
      * @return {@link Annotation} object or <code>null</code>
-     * @throws AnnotationException on error
+     * @throws CacheException on error
      */
     @Nullable
-    Annotation get(File file, String rev) throws AnnotationException;
+    Annotation get(File file, String rev) throws CacheException;
 
     /**
      * Store annotation for file into cache.
      * @param file file under source root to store the annotation for
      * @param annotation {@link Annotation} object
-     * @throws AnnotationException on error
+     * @throws CacheException on error
      */
-    void store(File file, Annotation annotation) throws AnnotationException;
+    void store(File file, Annotation annotation) throws CacheException;
 
     /**
      * Clear annotation cache entry for given file.

opengrok-indexer/src/main/java/org/opengrok/indexer/history/AnnotationException.java

@@ -22,35 +22,16 @@
  */
 package org.opengrok.indexer.history;
 
-import java.util.logging.Level;
-
 public class AnnotationException extends Exception {
     private static final long serialVersionUID = 1L;
 
-    private final Level level;
-
-    /**
-     * Construct a {@code HistoryException} with the specified message.
-     *
-     * @param msg the message string
-     */
-    public AnnotationException(String msg) {
-        this(msg, Level.WARNING);
-    }
-
-    public AnnotationException(String msg, Level level) {
-        super(msg);
-        this.level = level;
-    }
-
     /**
      * Construct a {@code HistoryException} with the specified cause.
      *
      * @param cause the cause of the exception
      */
     public AnnotationException(Throwable cause) {
         super(cause);
-        this.level = Level.WARNING;
     }
 
     /**
@@ -61,13 +42,5 @@ public AnnotationException(Throwable cause) {
      */
     public AnnotationException(String msg, Throwable cause) {
         super(msg, cause);
-        this.level = Level.WARNING;
-    }
-
-    /**
-     * @return log {@link Level} to be used when logging the exception
-     */
-    public Level getLevel() {
-        return level;
     }
 }

opengrok-indexer/src/main/java/org/opengrok/indexer/history/Cache.java

@@ -23,7 +23,6 @@
 package org.opengrok.indexer.history;
 
 import org.opengrok.indexer.logger.LoggerFactory;
-import org.opengrok.indexer.util.ForbiddenSymlinkException;
 
 import java.io.File;
 import java.util.Collection;
@@ -34,6 +33,13 @@ public interface Cache {
 
     Logger LOGGER = LoggerFactory.getLogger(Cache.class);
 
+    /**
+     * Create and initialize an empty cache if one doesn't exist already.
+     *
+     * @throws CacheException if initialization fails
+     */
+    void initialize() throws CacheException;
+
     /**
      * Get a string with information about the cache.
      * @return a free form text string describing the history instance
@@ -44,9 +50,9 @@ public interface Cache {
      * Clear the cache for a repository.
      *
      * @param repository the repository whose cache to clear
-     * @throws HistoryException if the cache couldn't be cleared
+     * @throws CacheException if the cache couldn't be cleared
      */
-    void clear(RepositoryInfo repository) throws HistoryException;
+    void clear(RepositoryInfo repository) throws CacheException;
 
     /**
      * Optimize how the history is stored on disk. This method is typically
@@ -56,9 +62,9 @@ public interface Cache {
      * or reordering the disk image of the cache in order to optimize
      * performance or space usage.
      *
-     * @throws HistoryException if an error happens during optimization
+     * @throws CacheException if an error happens during optimization
      */
-    void optimize() throws HistoryException;
+    void optimize() throws CacheException;
 
     /**
      * Check whether this cache implementation can store history for the given repository.
@@ -89,14 +95,12 @@ public interface Cache {
      * @param file the file to check
      * @return {@code true} if the file is in the cache, {@code false} otherwise
      */
-    boolean hasCacheForFile(File file) throws HistoryException;
+    boolean hasCacheForFile(File file) throws CacheException;
 
     /**
      * @param file source file
      * @return whether cache entry for given file is fresh
-     * @throws HistoryException on error
-     * @throws ForbiddenSymlinkException on error
-     * TODO: HistoryException -> CacheException
+     * @throws CacheException on error
      */
-    boolean isUpToDate(File file) throws HistoryException, ForbiddenSymlinkException;
+    boolean isUpToDate(File file) throws CacheException;
 }

opengrok-indexer/src/main/java/org/opengrok/indexer/history/CacheException.java

@@ -0,0 +1,76 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
+ */
+package org.opengrok.indexer.history;
+
+import java.util.logging.Level;
+
+/**
+ * Exception thrown when retrieval or manipulation of cache data fails.
+ */
+public class CacheException extends Exception {
+    private static final long serialVersionUID = 1L;
+
+    private final Level level;
+
+    /**
+     * Construct a {@code HistoryException} with the specified message.
+     *
+     * @param msg the message string
+     */
+    public CacheException(String msg) {
+        this(msg, Level.WARNING);
+    }
+
+    public CacheException(String msg, Level level) {
+        super(msg);
+        this.level = level;
+    }
+
+    /**
+     * Construct a {@code CacheException} with the specified cause.
+     *
+     * @param cause the cause of the exception
+     */
+    public CacheException(Throwable cause) {
+        super(cause);
+        this.level = Level.WARNING;
+    }
+
+    /**
+     * Construct a {@code CacheException} with the specified message and cause.
+     *
+     * @param msg the message string
+     * @param cause the cause of the exception
+     */
+    public CacheException(String msg, Throwable cause) {
+        super(msg, cause);
+        this.level = Level.WARNING;
+    }
+
+    /**
+     * @return log {@link Level} to be used when logging the exception
+     */
+    public Level getLevel() {
+        return level;
+    }
+}

opengrok-indexer/src/main/java/org/opengrok/indexer/history/FileAnnotationCache.java

@@ -28,7 +28,6 @@
 import org.jetbrains.annotations.VisibleForTesting;
 import org.opengrok.indexer.Metrics;
 import org.opengrok.indexer.logger.LoggerFactory;
-import org.opengrok.indexer.util.ForbiddenSymlinkException;
 import org.opengrok.indexer.util.Statistics;
 
 import java.beans.XMLDecoder;
@@ -81,19 +80,19 @@ static Annotation readCache(File file) throws IOException {
     }
 
     @VisibleForTesting
-    Annotation readAnnotation(File file) throws AnnotationException {
+    Annotation readAnnotation(File file) throws CacheException {
         File cacheFile;
         try {
             cacheFile = getCachedFile(file);
-        } catch (HistoryException | ForbiddenSymlinkException e) {
+        } catch (CacheException e) {
             LOGGER.log(Level.WARNING, "failed to get annotation cache file", e);
             return null;
         }
 
         try {
             return readCache(cacheFile);
         } catch (IOException e) {
-            throw new AnnotationException(String.format("failed to read annotation cache for '%s'", file), e);
+            throw new CacheException(String.format("failed to read annotation cache for '%s'", file), e);
         }
     }
 
@@ -106,12 +105,12 @@ Annotation readAnnotation(File file) throws AnnotationException {
     public boolean isUpToDate(File file) {
         try {
             return get(file, null) != null;
-        } catch (AnnotationException e) {
+        } catch (CacheException e) {
             return false;
         }
     }
 
-    public Annotation get(File file, @Nullable String rev) throws AnnotationException {
+    public Annotation get(File file, @Nullable String rev) throws CacheException {
         Annotation annotation = null;
         String latestRevision = LatestRevisionUtil.getLatestRevision(file);
         if (rev == null || (latestRevision != null && latestRevision.equals(rev))) {
@@ -157,23 +156,23 @@ public Annotation get(File file, @Nullable String rev) throws AnnotationExceptio
         return annotation;
     }
 
-    public void store(File file, Annotation annotation) throws AnnotationException {
+    public void store(File file, Annotation annotation) throws CacheException {
         if (annotation.getRevision() == null || annotation.getRevision().isEmpty()) {
-            throw new AnnotationException(String.format("annotation for ''%s'' does not contain revision", file));
+            throw new CacheException(String.format("annotation for ''%s'' does not contain revision", file));
         }
 
         File cacheFile;
         try {
             cacheFile = getCachedFile(file);
-        } catch (ForbiddenSymlinkException | HistoryException e) {
+        } catch (CacheException e) {
             LOGGER.log(Level.FINER, e.getMessage());
             return;
         }
 
         File dir = cacheFile.getParentFile();
         // calling isDirectory() twice to prevent a race condition
         if (!dir.isDirectory() && !dir.mkdirs() && !dir.isDirectory()) {
-            throw new AnnotationException("Unable to create cache directory '" + dir + "'.");
+            throw new CacheException("Unable to create cache directory '" + dir + "'.");
         }
 
         Statistics statistics = new Statistics();