Home » Documentation » Bundles

Accessing File System Resources (org.apache.sling.fsresource)


The Apache Sling File System Resource Provider provides access to the operating system's file system through the Sling ResourceResolver. Multiple locations may be mapped into the resource tree by configuring the file system location and the resource tree root path for each location to be mapped. The provider supports mapping folders and files as binaries, and content structures stored in JSON files or FileVault XML format.

To activate this feature, install the org.apache.sling.fsresource bundle. You can get it from the Sling downloads page or from Maven Central.

Currently two major versions are maintained - choose the correct version depending on your Sling environment:

Resource Types

Files and directories are mapped into the resource tree as regular Resource instances whose resource type depends on the actual nature of the mapped file system resource:

Content stored in JSON or FileVault XML files are mapped with the resource type stored in the files. If a resource type is missing nt:unstructured is used as fallback.


File system resources extend from Sling's AbstractResource class and thus are adaptable to any type for which an AdapterFactory is registered supporting file system resources. In addition File system Resources support the following adapters natively:


The File System Resource Provider is configured with OSGi Configuration Admin factory configurtions whose factory PID is org.apache.sling.fsprovider.internal.FsResourceProvider. Configuration can be managed using the OSGi Configuration Admin API, through the Web Console or by any other means supporting Configuration Admin configurations. Each configuration "mounts" a specific file system path into the resource hierarchy.

Which files are mounted depends on the 'File system layout' configuration parameter:

Configuration parameters for each mapping:

Parameter Name Description
File System Root provider.file File system directory mapped to the virtual resource tree. This property must not be an empty string. If the path is relative it is resolved against sling.home or the current working directory. The path may be a file or folder. If the path does not address an existing file or folder, an empty folder is created.
Provider Root provider.root (2.x), provider.roots (1.x) 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.
File system layout provider.fs.mode File system layout mode for files, folders and content.
Init. Content Options provider.initial.content.import.options Import options for Sling-Initial-Content file system layout. Supported options: overwrite, ignoreImportProviders.
FileVault Filter provider.filevault.filterxml.path Path to META-INF/vault/filter.xml when using FileVault XML file system layout.
Check Interval provider.checkinterval 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.
Cache Size provider.cache.size Max. number of content files cached in memory.

FILES_FOLDERS file system layout

The mode maps only files and folders. This was the only mode supported in fsresource versions before 1.3.


INITIAL_CONTENT file system layout

The mode maps files and folders, and content files stored in JSON or jcr.xml files. The layout has to match the conventions of the Apache Sling JCR Content Loader. The bundle header Sling-Initial-Content defines where and how the content should be loaded to.

This mode is best use together with the Maven Sling Plugin, which automatically creates the appropriate File System Resource Provider configurations for a Maven bundle project containing content structures. For each path an individual configuration is created.

Usage - deploy OSGi bundle from current maven project and register the appropriate OSGi configuration mappings:

$ mvn -Dsling.mountByFS=true sling:install

Only register the appropriate mappings:

$ mvn sling:fsmount

Remove the mappings:

$ mvn sling:fsunmount


FILEVAULT_XML file system layout

The mode maps an maven project containing an expanded content package which uses the Jackrabbit FileVault XML layout in the running Sling instance. The existing of a filter file META-INF/vault/filter.xml is mandatory.

This mode is best use together with the Maven Sling Plugin, which automatically creates the appropriate File System Resource Provider configurations. For each path defined in the filter.xml one mapping configuration is created. The include/exclude definitions are respected as well.

Usage - register the appropriate mappings:

$ mvn sling:fsmount

Remove the mappings:

$ mvn sling:fsunmount


Rev. 1786383 by sseifert on Fri, 10 Mar 2017 16:40:06 +0000
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.