Built by Maven

sling:fsmount

Full name:

org.apache.sling:sling-maven-plugin:2.4.0:fsmount

Description:

Creates OSGi configurations for the Apache Sling File System Resource Provider.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 2.2.0.

Required Parameters

Name Type Since Description
<bundleFileName> String 2.2.0 The name of the generated JAR file.
Default value is: ${project.build.directory}/${project.build.finalName}.jar.
User property is: sling.file.
<failOnError> boolean 2.2.0 Determines whether or not to fail the build if the HTTP POST or PUT returns an non-OK response code.
Default value is: true.
User property is: sling.failOnError.
<password> String 2.2.0 The password to authenticate at the running Sling instance.
Default value is: admin.
User property is: sling.password.
<skip> boolean 2.2.0 If set to true Sling File System Resource mount/unmount commands are ignored.
Default value is: false.
User property is: sling.fsmount.skip.
<slingUrl> String 2.2.0 The URL of the running Sling instance.

The default is only useful for WebConsole deployment.

For WebDAV deployment it is recommended to include the Sling Simple WebDAV servlet root, for instance http://localhost:8080/dav/default/libs/sling/install. Omitting the dav/default segment can lead to conflicts with other servlets.


Default value is: http://localhost:8080/system/console.
User property is: sling.url.
<user> String 2.2.0 The user name to authenticate at the running Sling instance.
Default value is: admin.
User property is: sling.user.

Optional Parameters

Name Type Since Description
<deployFsResourceBundle> boolean 2.3.0 Deploy org.apache.sling.fsresource to Sling instance bundle when it is not deployed already.
Default value is: true.
<deployFsResourceBundlePrerequisites> List 2.3.0 Bundles that have to be installed as prerequisites to execute this goal. With multiple entries in the list different bundles with different preconditions can be defined.
Default value is:: 
<deployFsResourceBundlePrerequisites>
  <bundlePrerequisite>
    <bundles>
      <bundle>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.fsresource</artifactId>
        <version>2.1.14</version>
      </bundle>
    </bundles>
    <preconditions>
      <bundle>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.resourceresolver</artifactId>
        <version>1.5.18</version>
      </bundle>
    </preconditions>
  </bundlePrerequisite>
  <bundlePrerequisite>
    <bundles>
      <bundle>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.fsresource</artifactId>
        <version>1.4.8</version>
      </bundle>
    </bundles>
  </bundlePrerequisite>
</deployFsResourceBundlePrerequisites>

<deploymentMethod> BundleDeploymentMethod 2.3.0 Bundle deployment method. One of the following three values are allowed
  1. WebConsole, uses the Felix Web Console REST API for deployment (HTTP POST). This is the default. Make sure that slingUrl points to the Felix Web Console in that case.
  2. WebDAV, uses WebDAV for deployment (HTTP PUT). Make sure that slingUrl points to the entry path of the Sling WebDAV bundle (usually below regular Sling root URL). Issues a HTTP Delete for the uninstall goal.
  3. SlingPostServlet, uses the Sling Post Servlet for deployment (HTTP POST). Make sure that slingUrl points a path which is handled by the Sling POST Servlet (usually below regular Sling root URL).
This has precedence over the deprecated parameter usePut.
Default value is: WebConsole.
User property is: sling.deploy.method.
<fileVaultFilterXmlFile> File 2.2.0 Path to META-INF/vault/filter.xml when using FileVault XML filesystem layout.
User property is: sling.filevault.filterxml.file.
<fileVaultJcrRootFile> File 2.2.0 FileVault filesystem layout content root folder.
User property is: sling.filevault.jcr_root.file.
<slingConsoleUrl> String 2.2.0 The WebConsole URL of the running Sling instance. This is required for file system provider operations. If not configured the value of slingUrl is used.
User property is: sling.console.url.
<slingUrlSuffix> String 2.2.0 An optional url suffix which will be appended to the sling.url for use as the real target url. This allows to configure different target URLs in each POM, while using the same common sling.url in a parent POM (eg. sling.url=http://localhost:8080 and sling.urlSuffix=/project/specific/path). This is typically used in conjunction with WebDAV or SlingPostServlet deployment methods.
User property is: sling.urlSuffix.

Parameter Details

<bundleFileName>

The name of the generated JAR file.
  • Type: java.lang.String
  • Since: 2.2.0
  • Required: Yes
  • User Property: sling.file
  • Default: ${project.build.directory}/${project.build.finalName}.jar

<deployFsResourceBundle>

Deploy org.apache.sling.fsresource to Sling instance bundle when it is not deployed already.
  • Type: boolean
  • Since: 2.3.0
  • Required: No
  • Default: true

<deployFsResourceBundlePrerequisites>

Bundles that have to be installed as prerequisites to execute this goal. With multiple entries in the list different bundles with different preconditions can be defined.
Default value is:: 
<deployFsResourceBundlePrerequisites>
  <bundlePrerequisite>
    <bundles>
      <bundle>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.fsresource</artifactId>
        <version>2.1.14</version>
      </bundle>
    </bundles>
    <preconditions>
      <bundle>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.resourceresolver</artifactId>
        <version>1.5.18</version>
      </bundle>
    </preconditions>
  </bundlePrerequisite>
  <bundlePrerequisite>
    <bundles>
      <bundle>
        <groupId>org.apache.sling</groupId>
        <artifactId>org.apache.sling.fsresource</artifactId>
        <version>1.4.8</version>
      </bundle>
    </bundles>
  </bundlePrerequisite>
</deployFsResourceBundlePrerequisites>
  • Type: java.util.List
  • Since: 2.3.0
  • Required: No

<deploymentMethod>

Bundle deployment method. One of the following three values are allowed
  1. WebConsole, uses the Felix Web Console REST API for deployment (HTTP POST). This is the default. Make sure that slingUrl points to the Felix Web Console in that case.
  2. WebDAV, uses WebDAV for deployment (HTTP PUT). Make sure that slingUrl points to the entry path of the Sling WebDAV bundle (usually below regular Sling root URL). Issues a HTTP Delete for the uninstall goal.
  3. SlingPostServlet, uses the Sling Post Servlet for deployment (HTTP POST). Make sure that slingUrl points a path which is handled by the Sling POST Servlet (usually below regular Sling root URL).
This has precedence over the deprecated parameter usePut.
  • Type: org.apache.sling.maven.bundlesupport.deploy.BundleDeploymentMethod
  • Since: 2.3.0
  • Required: No
  • User Property: sling.deploy.method
  • Default: WebConsole

<failOnError>

Determines whether or not to fail the build if the HTTP POST or PUT returns an non-OK response code.
  • Type: boolean
  • Since: 2.2.0
  • Required: Yes
  • User Property: sling.failOnError
  • Default: true

<fileVaultFilterXmlFile>

Path to META-INF/vault/filter.xml when using FileVault XML filesystem layout.
  • Type: java.io.File
  • Since: 2.2.0
  • Required: No
  • User Property: sling.filevault.filterxml.file

<fileVaultJcrRootFile>

FileVault filesystem layout content root folder.
  • Type: java.io.File
  • Since: 2.2.0
  • Required: No
  • User Property: sling.filevault.jcr_root.file

<password>

The password to authenticate at the running Sling instance.
  • Type: java.lang.String
  • Since: 2.2.0
  • Required: Yes
  • User Property: sling.password
  • Default: admin

<skip>

If set to true Sling File System Resource mount/unmount commands are ignored.
  • Type: boolean
  • Since: 2.2.0
  • Required: Yes
  • User Property: sling.fsmount.skip
  • Default: false

<slingConsoleUrl>

The WebConsole URL of the running Sling instance. This is required for file system provider operations. If not configured the value of slingUrl is used.
  • Type: java.lang.String
  • Since: 2.2.0
  • Required: No
  • User Property: sling.console.url

<slingUrl>

The URL of the running Sling instance.

The default is only useful for WebConsole deployment.

For WebDAV deployment it is recommended to include the Sling Simple WebDAV servlet root, for instance http://localhost:8080/dav/default/libs/sling/install. Omitting the dav/default segment can lead to conflicts with other servlets.

  • Type: java.lang.String
  • Since: 2.2.0
  • Required: Yes
  • User Property: sling.url
  • Default: http://localhost:8080/system/console

<slingUrlSuffix>

An optional url suffix which will be appended to the sling.url for use as the real target url. This allows to configure different target URLs in each POM, while using the same common sling.url in a parent POM (eg. sling.url=http://localhost:8080 and sling.urlSuffix=/project/specific/path). This is typically used in conjunction with WebDAV or SlingPostServlet deployment methods.
  • Type: java.lang.String
  • Since: 2.2.0
  • Required: No
  • User Property: sling.urlSuffix

<user>

The user name to authenticate at the running Sling instance.
  • Type: java.lang.String
  • Since: 2.2.0
  • Required: Yes
  • User Property: sling.user
  • Default: admin