[accumulo] branch 2.0 updated: Fix #1202 Correct documented vfs cache dir default

[ct...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ctubbsii pushed a commit to branch 2.0
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/2.0 by this push:
     new 87639a3  Fix #1202 Correct documented vfs cache dir default
87639a3 is described below

commit 87639a355251e98c107ef072639bccc6de9cffc4
Author: Christopher Tubbs <ct...@apache.org>
AuthorDate: Thu Jun 13 17:13:59 2019 -0400

    Fix #1202 Correct documented vfs cache dir default
    
    Update the default value for general.vfs.cache.dir to reflect the actual
    default used in AccumuloVFSClassLoader. Also update the description to
    more accurately represent how the value is used as a base directory for
    a subdirectory which the vfs class loader code uses.
---
 .../java/org/apache/accumulo/core/conf/Property.java  | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/core/src/main/java/org/apache/accumulo/core/conf/Property.java b/core/src/main/java/org/apache/accumulo/core/conf/Property.java
index 69f9f63..7879ae4 100644
--- a/core/src/main/java/org/apache/accumulo/core/conf/Property.java
+++ b/core/src/main/java/org/apache/accumulo/core/conf/Property.java
@@ -16,7 +16,6 @@
  */
 package org.apache.accumulo.core.conf;
 
-import java.io.File;
 import java.lang.annotation.Annotation;
 import java.util.EnumSet;
 import java.util.HashMap;
@@ -814,6 +813,9 @@ public enum Property {
           + "constraint."),
 
   // VFS ClassLoader properties
+
+  // this property shouldn't be used directly; it exists solely to document the default value
+  // defined by its use in AccumuloVFSClassLoader when generating the property documentation
   VFS_CLASSLOADER_SYSTEM_CLASSPATH_PROPERTY(
       AccumuloVFSClassLoader.VFS_CLASSLOADER_SYSTEM_CLASSPATH_PROPERTY, "", PropertyType.STRING,
       "Configuration for a system level vfs classloader. Accumulo jar can be"
@@ -829,11 +831,16 @@ public enum Property {
           + " `general.vfs.context.classpath.<name>.delegation=post`, where `<name>` is"
           + " your context name. If delegation is not specified, it defaults to loading"
           + " from parent classloader first."),
-  VFS_CLASSLOADER_CACHE_DIR(AccumuloVFSClassLoader.VFS_CACHE_DIR,
-      File.separator + "tmp" + File.separator + "accumulo-vfs-cache", PropertyType.ABSOLUTEPATH,
-      "Directory to use for the vfs cache. The cache will keep a soft reference"
-          + " to all of the classes loaded in the VM. This should be on local disk on"
-          + " each node with sufficient space."),
+
+  // this property shouldn't be used directly; it exists solely to document the default value
+  // defined by its use in AccumuloVFSClassLoader when generating the property documentation
+  VFS_CLASSLOADER_CACHE_DIR(AccumuloVFSClassLoader.VFS_CACHE_DIR, "${java.io.tmpdir}",
+      PropertyType.ABSOLUTEPATH,
+      "The base directory to use for the vfs cache. The actual cached files will be located"
+          + " in a subdirectory, `accumulo-vfs-cache-<jvmProcessName>-${user.name}`, where"
+          + " `<jvmProcessName>` is determined by the JVM's internal management engine."
+          + " The cache will keep a soft reference to all of the classes loaded in the VM."
+          + " This should be on local disk on each node with sufficient space."),
 
   // General properties for configuring replication
   REPLICATION_PREFIX("replication.", null, PropertyType.PREFIX,