You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ss...@apache.org on 2017/03/10 16:30:37 UTC

svn commit: r1786380 - in /sling/branches/fsresource-1.x/src: main/java/org/apache/sling/fsprovider/internal/ main/java/org/apache/sling/fsprovider/internal/mapper/ test/java/org/apache/sling/fsprovider/internal/

Author: sseifert
Date: Fri Mar 10 16:30:36 2017
New Revision: 1786380

URL: http://svn.apache.org/viewvc?rev=1786380&view=rev
Log:
cosmetic: use consistent wording, reorder config attributes

Modified:
    sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java
    sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java
    sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java
    sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java
    sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java
    sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java
    sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java
    sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java

Modified: sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java
URL: http://svn.apache.org/viewvc/sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java?rev=1786380&r1=1786379&r2=1786380&view=diff
==============================================================================
--- sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java (original)
+++ sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsMode.java Fri Mar 10 16:30:36 2017
@@ -29,7 +29,7 @@ public enum FsMode {
     FILES_FOLDERS,
 
     /**
-     * Sling-Initial-Content filesystem layout, supports file and folders ant content files in JSON and jcr.xml format.
+     * Sling-Initial-Content file system layout, supports file and folders ant content files in JSON and jcr.xml format.
      */
     INITIAL_CONTENT,
     

Modified: sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java?rev=1786380&r1=1786379&r2=1786380&view=diff
==============================================================================
--- sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java (original)
+++ sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/FsResourceProvider.java Fri Mar 10 16:30:36 2017
@@ -82,14 +82,10 @@ public final class FsResourceProvider im
     public static final String RESOURCE_METADATA_FILE_DIRECTORY = ":org.apache.sling.fsprovider.file.directory";
     
     @ObjectClassDefinition(name = "Apache Sling File System Resource Provider",
-            description = "Configure an instance of the filesystem " +
-                          "resource provider in terms of provider root and filesystem location")
+            description = "Configure an instance of the file system " +
+                          "resource provider in terms of provider root and file system location")
     public @interface Config {
-        /**
-         * The name of the configuration property providing file system path of
-         * files and folders mapped into the resource tree (value is
-         * "provider.file").
-         */
+
         @AttributeDefinition(name = "File System Root",
                 description = "File system directory mapped to the virtual " +
                         "resource tree. This property must not be an empty string. If the path is " +
@@ -98,41 +94,38 @@ public final class FsResourceProvider im
                         "file or folder, an empty folder is created.")
         String provider_file();
 
-        /**
-         * The name of the configuration property providing the check interval
-         * for file changes (value is "provider.checkinterval").
-         */
-        @AttributeDefinition(name = "Check Interval",
-                             description = "If the interval has a value higher than 100, the provider will " +
-             "check the file system for changes periodically. This interval defines the period in milliseconds " +
-             "(the default is 1000). If a change is detected, resource events are sent through the event admin.")
-        long provider_checkinterval() default 1000;
-
-        @AttributeDefinition(name = "Provider Roots",
-                description = "Locations in the virtual resource tree where the " +
-                "filesystem resources are mapped in. This property must contain at least one non-empty string.")
+        @AttributeDefinition(name = "Provider Root",
+                description = "Location in the virtual resource tree where the " +
+                "file system resources are mapped in. This property must not be an empty string. Only one path is supported.")
         String[] provider_roots();
         
-        @AttributeDefinition(name = "Filesystem layout",
-                description = "Filesystem layout mode for files, folders and content.",
+        @AttributeDefinition(name = "File system layout",
+                description = "File system layout mode for files, folders and content.",
                 options={
                         @Option(value="FILES_FOLDERS", label="FILES_FOLDERS - "
                                 + "Support only files and folders (classic mode)"),
                         @Option(value="INITIAL_CONTENT", label="INITIAL_CONTENT - "
-                                + "Sling-Initial-Content filesystem layout, supports file and folders ant content files in JSON and jcr.xml format"),
+                                + "Sling-Initial-Content file system layout, supports file and folders ant content files in JSON and jcr.xml format"),
                         @Option(value="FILEVAULT_XML", label="FILEVAULT_XML - "
                                 + "FileVault XML format (expanded content package)"),
                 })
         FsMode provider_fs_mode() default FsMode.FILES_FOLDERS;
         
         @AttributeDefinition(name = "Init. Content Options",
-                description = "Import options for Sling-Initial-Content filesystem layout. Supported options: overwrite, ignoreImportProviders.")
+                description = "Import options for Sling-Initial-Content file system layout. Supported options: overwrite, ignoreImportProviders.")
         String provider_initial_content_import_options();
         
         @AttributeDefinition(name = "FileVault Filter",
-                description = "Path to META-INF/vault/filter.xml when using FileVault XML filesystem layout.")
+                description = "Path to META-INF/vault/filter.xml when using FileVault XML file system layout.")
         String provider_filevault_filterxml_path();
         
+
+        @AttributeDefinition(name = "Check Interval",
+                             description = "If the interval has a value higher than 100, the provider will " +
+             "check the file system for changes periodically. This interval defines the period in milliseconds " +
+             "(the default is 1000). If a change is detected, resource events are sent through the event admin.")
+        long provider_checkinterval() default 1000;
+
         @AttributeDefinition(name = "Cache Size",
                 description = "Max. number of content files cached in memory.")
         int provider_cache_size() default 10000;
@@ -152,7 +145,7 @@ public final class FsResourceProvider im
     // The monitor to detect file changes.
     private FileMonitor monitor;
     
-    // maps filesystem to resources
+    // maps file system to resources
     private FsMode fsMode;
     private FsResourceMapper fileMapper;
     private FsResourceMapper contentFileMapper;

Modified: sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java
URL: http://svn.apache.org/viewvc/sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java?rev=1786380&r1=1786379&r2=1786380&view=diff
==============================================================================
--- sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java (original)
+++ sling/branches/fsresource-1.x/src/main/java/org/apache/sling/fsprovider/internal/mapper/FileVaultResourceMapper.java Fri Mar 10 16:30:36 2017
@@ -104,7 +104,7 @@ public final class FileVaultResourceMapp
             }
         }
         
-        // additional check for children in filesystem
+        // additional check for children in file system
         File parentFile = getFile(parentPath);
         if (parentFile != null && parentFile.isDirectory()) {
             for (File childFile : parentFile.listFiles()) {

Modified: sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java
URL: http://svn.apache.org/viewvc/sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java?rev=1786380&r1=1786379&r2=1786380&view=diff
==============================================================================
--- sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java (original)
+++ sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileMonitorTest.java Fri Mar 10 16:30:36 2017
@@ -42,7 +42,7 @@ import org.osgi.service.event.EventConst
 import org.osgi.service.event.EventHandler;
 
 /**
- * Test events when changing filesystem content (Sling-Initial-Content).
+ * Test events when changing file system content (Sling-Initial-Content).
  */
 public class FileMonitorTest {
 

Modified: sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java
URL: http://svn.apache.org/viewvc/sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java?rev=1786380&r1=1786379&r2=1786380&view=diff
==============================================================================
--- sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java (original)
+++ sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FileVaultFileMonitorTest.java Fri Mar 10 16:30:36 2017
@@ -42,7 +42,7 @@ import org.osgi.service.event.EventConst
 import org.osgi.service.event.EventHandler;
 
 /**
- * Test events when changing filesystem content (FileVault XML).
+ * Test events when changing file system content (FileVault XML).
  */
 public class FileVaultFileMonitorTest {
     

Modified: sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java
URL: http://svn.apache.org/viewvc/sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java?rev=1786380&r1=1786379&r2=1786380&view=diff
==============================================================================
--- sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java (original)
+++ sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/FilesFolderTest.java Fri Mar 10 16:30:36 2017
@@ -34,7 +34,7 @@ import org.junit.Rule;
 import org.junit.Test;
 
 /**
- * Test access to files and folders from filesystem.
+ * Test access to files and folders from file system.
  */
 public class FilesFolderTest {
 

Modified: sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java
URL: http://svn.apache.org/viewvc/sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java?rev=1786380&r1=1786379&r2=1786380&view=diff
==============================================================================
--- sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java (original)
+++ sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JcrXmlContentTest.java Fri Mar 10 16:30:36 2017
@@ -48,7 +48,7 @@ import org.junit.Test;
 import com.google.common.collect.ImmutableList;
 
 /**
- * Test access to files and folders from filesystem.
+ * Test access to files and folders from file system.
  */
 public class JcrXmlContentTest {
 

Modified: sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java
URL: http://svn.apache.org/viewvc/sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java?rev=1786380&r1=1786379&r2=1786380&view=diff
==============================================================================
--- sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java (original)
+++ sling/branches/fsresource-1.x/src/test/java/org/apache/sling/fsprovider/internal/JsonContentTest.java Fri Mar 10 16:30:36 2017
@@ -59,7 +59,7 @@ import com.google.common.collect.Immutab
 import com.google.common.collect.ImmutableSet;
 
 /**
- * Test access to files and folders and JSON content from filesystem.
+ * Test access to files and folders and JSON content from file system.
  */
 public class JsonContentTest {