| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/fsmount-mojo.xml at 2022-08-21 |
| | Rendered using Apache Maven Fluido Skin 1.11.1 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> |
| <title>Apache Sling Maven Plugin – sling:fsmount</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-1.11.1.min.js"></script> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| |
| (function() { |
| var u="https://analytics.apache.org"; |
| _paq.push(['setTrackerUrl', u+'/matomo.php']); |
| _paq.push(['setSiteId', '6']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| <style>.github-fork-ribbon:before { background-color: gray; }</style> |
| </head> |
| <body class="topBarDisabled"> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/sling-maven-plugin" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><a href="https://sling.apache.org/" id="bannerLeft"><img src="https://sling.apache.org/res/logos/sling.svg" alt="Apache Sling" style="width: 123px; height: 63px;" /></a></div> |
| <div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="https://sling.apache.org/res/logos/apache.png" alt="Apache" style="" /></a></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li class=""><a href="https://sling.apache.org/" class="externalLink" title="Apache Sling">Apache Sling</a><span class="divider">/</span></li> |
| <li class=""><a href="https://sling.apache.org/components/" class="externalLink" title="Maven Plugins">Maven Plugins</a><span class="divider">/</span></li> |
| <li class=""><a href="index.html" title="Apache Sling Maven Plugin">Apache Sling Maven Plugin</a><span class="divider">/</span></li> |
| <li class="active ">sling:fsmount</li> |
| <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2022-08-21</li> |
| <li id="projectVersion" class="pull-right">Version: 3.0.2</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Overview</li> |
| <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="bundle-installation.html" title="Bundle Installation"><span class="none"></span>Bundle Installation</a></li> |
| <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10" > |
| |
| |
| <section> |
| <h2><a name="sling:fsmount"></a>sling:fsmount</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.apache.sling:sling-maven-plugin:3.0.2:fsmount</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Create OSGi configurations for the <a class="externalLink" href="https://sling.apache.org/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.html">Apache |
| Sling File System Resource Provider</a>. In case a bundle file is |
| supplied via <code>AbstractFsMountMojo.bundleFileName</code> the |
| configuration for its <a class="externalLink" href="https://sling.apache.org/documentation/bundles/content-loading-jcr-contentloader.html#initial-content-loading">initial |
| content</a> is created. Otherwise it tries to detect a FileVault |
| content package layout starting at |
| <code>AbstractFsMountMojo.fileVaultJcrRootFile</code> or the |
| project's resource directories and potentially creates a |
| configuration for each path in the package's |
| <code>filter.xml</code>.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>The goal is not marked as thread-safe and thus does not support parallel builds.</li> |
| |
| <li>Since version: <code>2.2.0</code>.</li> |
| </ul> |
| <section> |
| <h3><a name="Required_Parameters"></a>Required Parameters</h3> |
| |
| <table class="table table-striped" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#slingUrl"><slingUrl></a></code></td> |
| |
| <td><code>URI</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>The URL of the running Sling instance. |
| |
| <p>The default is only useful for <b>WebConsole</b> |
| deployment.</p> |
| |
| <p>For <b>WebDAV</b> deployment it is recommended to |
| include the <a class="externalLink" href="https://sling.apache.org/documentation/development/repository-based-development.html#separate-uri-space-webdav">Sling |
| Simple WebDAV servlet root</a>, for instance <a class="externalLink" href="http://localhost:8080/dav/default/libs/sling/install">http://localhost:8080/dav/default/libs/sling/install</a>. |
| Omitting the <code>dav/default</code> segment can lead to conflicts |
| with other servlets.</p><br /><b>Default value is</b>: <code>http://localhost:8080/system/console</code>.<br /><b>User property is</b>: <code>sling.url</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Optional_Parameters"></a>Optional Parameters</h3> |
| |
| <table class="table table-striped" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#bundleFileName"><bundleFileName></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>The path of the bundle file whose Sling Initial Content should be |
| mounted.<br /><b>Default value is</b>: <code>${project.build.directory}/${project.build.finalName}.jar</code>.<br /><b>User property is</b>: <code>sling.file</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#deployFsResourceBundle"><deployFsResourceBundle></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>2.3.0</code></td> |
| |
| <td>Deploy <code>org.apache.sling.fsresource</code> to Sling instance |
| bundle when it is not deployed already.<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#deployFsResourceBundlePrerequisites"><deployFsResourceBundlePrerequisites></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>2.3.0</code></td> |
| |
| <td>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.<br /> |
| <b>Default value is:</b>: |
| |
| <div> |
| <pre> |
| <deployFsResourceBundlePrerequisites> |
| <bundlePrerequisite> |
| <bundles> |
| <bundle> |
| <groupId>org.apache.sling</groupId> |
| <artifactId>org.apache.sling.commons.johnzon</artifactId> |
| <version>1.0.0</version> |
| </bundle> |
| <bundle> |
| <groupId>org.apache.commons</groupId> |
| <artifactId>commons-collections4</artifactId> |
| <version>4.1</version> |
| <symbolicName>org.apache.commons.collections4</symbolicName> |
| </bundle> |
| <bundle> |
| <groupId>org.apache.sling</groupId> |
| <artifactId>org.apache.sling.fsresource</artifactId> |
| <version>2.1.16</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> |
| </pre></div><br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#deploymentMethod"><deploymentMethod></a></code></td> |
| |
| <td><code>BundleDeploymentMethod</code></td> |
| |
| <td><code>2.3.0</code></td> |
| |
| <td>Bundle deployment method. One of the following three values are |
| allowed |
| |
| <ol style="list-style-type: decimal"> |
| |
| <li><b>WebConsole</b>, uses the <a class="externalLink" href="http://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests">Felix |
| Web Console REST API</a> for deployment (HTTP POST). This is the |
| default. Make sure that <code>slingUrl</code> points to the Felix |
| Web Console in that case.</li> |
| |
| <li><b>WebDAV</b>, uses <a class="externalLink" href="https://sling.apache.org/documentation/development/repository-based-development.html">WebDAV</a> |
| for deployment (HTTP PUT). Make sure that <code>slingUrl</code> |
| points to the entry path of the Sling WebDAV bundle (defaults to |
| <code>/dav/default</code> in the Sling starter). Issues a HTTP |
| Delete for the uninstall goal.</li> |
| |
| <li><b>SlingPostServlet</b>, uses the <a class="externalLink" href="https://sling.apache.org/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html">Sling |
| Post Servlet</a> for deployment (HTTP POST). Make sure that |
| <code>slingUrl</code> points a path which is handled by the Sling |
| POST Servlet (usually below regular Sling root URL).</li> |
| </ol> |
| For more details refer to <a href="bundle-installation.html">Bundle |
| Installation</a>.<br /><b>Default value is</b>: <code>WebConsole</code>.<br /><b>User property is</b>: <code>sling.deploy.method</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#failOnError"><failOnError></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>Determines whether or not to fail the build if the HTTP POST or PUT |
| returns an non-OK response code.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>sling.failOnError</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#fileVaultFilterXmlFile"><fileVaultFilterXmlFile></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>Path to META-INF/vault/filter.xml when using FileVault XML |
| filesystem layout.<br /><b>User property is</b>: <code>sling.filevault.filterxml.file</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#fileVaultJcrRootFile"><fileVaultJcrRootFile></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>FileVault filesystem layout content root folder.<br /><b>User property is</b>: <code>sling.filevault.jcr_root.file</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#httpConnectTimeoutSec"><httpConnectTimeoutSec></a></code></td> |
| |
| <td><code>int</code></td> |
| |
| <td><code>3.0.0</code></td> |
| |
| <td>HTTP connection timeout (in seconds). Determines the timeout until |
| a new connection is fully established. This may also include |
| transport security negotiation exchanges such as <code>SSL</code> |
| or <code>TLS</code> protocol negotiation).<br /><b>Default value is</b>: <code>10</code>.<br /><b>User property is</b>: <code>sling.httpConnectTimeoutSec</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#httpResponseTimeoutSec"><httpResponseTimeoutSec></a></code></td> |
| |
| <td><code>int</code></td> |
| |
| <td><code>3.0.0</code></td> |
| |
| <td>HTTP response timeout (in seconds). Determines the timeout until |
| arrival of a response from the opposite endpoint.<br /><b>Default value is</b>: <code>60</code>.<br /><b>User property is</b>: <code>sling.httpResponseTimeoutSec</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#password"><password></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>The password to authenticate at the running Sling instance.<br /><b>Default value is</b>: <code>admin</code>.<br /><b>User property is</b>: <code>sling.password</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#skip"><skip></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>If set to <code>true</code> Sling File System Resource |
| mount/unmount commands are ignored.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>sling.fsmount.skip</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#slingConsoleUrl"><slingConsoleUrl></a></code></td> |
| |
| <td><code>URI</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>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.<br /><b>User property is</b>: <code>sling.console.url</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#slingUrlSuffix"><slingUrlSuffix></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>An optional url suffix which will be appended to the |
| <code>sling.url</code> for use as the real target url. This allows |
| to configure different target URLs in each POM, while using the |
| same common <code>sling.url</code> in a parent POM (eg. |
| <code>sling.url=http://localhost:8080</code> and |
| <code>sling.urlSuffix=/project/specific/path</code>). This is |
| typically used in conjunction with WebDAV or SlingPostServlet |
| deployment methods.<br /><b>User property is</b>: <code>sling.urlSuffix</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#user"><user></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>2.2.0</code></td> |
| |
| <td>The user name to authenticate at the running Sling instance.<br /><b>Default value is</b>: <code>admin</code>.<br /><b>User property is</b>: <code>sling.user</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3CbundleFileName.3E"></a><b><a name="bundleFileName"><bundleFileName></a></b></h4> |
| |
| <div>The path of the bundle file whose Sling Initial Content should be |
| mounted.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.file</code></li> |
| |
| <li><b>Default</b>: <code>${project.build.directory}/${project.build.finalName}.jar</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CdeployFsResourceBundle.3E"></a><b><a name="deployFsResourceBundle"><deployFsResourceBundle></a></b></h4> |
| |
| <div>Deploy <code>org.apache.sling.fsresource</code> to Sling instance |
| bundle when it is not deployed already.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>2.3.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CdeployFsResourceBundlePrerequisites.3E"></a><b><a name="deployFsResourceBundlePrerequisites"><deployFsResourceBundlePrerequisites></a></b></h4> |
| |
| <div>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.<br /> |
| <b>Default value is:</b>: |
| |
| <div> |
| <pre> |
| <deployFsResourceBundlePrerequisites> |
| <bundlePrerequisite> |
| <bundles> |
| <bundle> |
| <groupId>org.apache.sling</groupId> |
| <artifactId>org.apache.sling.commons.johnzon</artifactId> |
| <version>1.0.0</version> |
| </bundle> |
| <bundle> |
| <groupId>org.apache.commons</groupId> |
| <artifactId>commons-collections4</artifactId> |
| <version>4.1</version> |
| <symbolicName>org.apache.commons.collections4</symbolicName> |
| </bundle> |
| <bundle> |
| <groupId>org.apache.sling</groupId> |
| <artifactId>org.apache.sling.fsresource</artifactId> |
| <version>2.1.16</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> |
| </pre></div></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Since</b>: <code>2.3.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CdeploymentMethod.3E"></a><b><a name="deploymentMethod"><deploymentMethod></a></b></h4> |
| |
| <div>Bundle deployment method. One of the following three values are |
| allowed |
| |
| <ol style="list-style-type: decimal"> |
| |
| <li><b>WebConsole</b>, uses the <a class="externalLink" href="http://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests">Felix |
| Web Console REST API</a> for deployment (HTTP POST). This is the |
| default. Make sure that <code>slingUrl</code> points to the Felix |
| Web Console in that case.</li> |
| |
| <li><b>WebDAV</b>, uses <a class="externalLink" href="https://sling.apache.org/documentation/development/repository-based-development.html">WebDAV</a> |
| for deployment (HTTP PUT). Make sure that <code>slingUrl</code> |
| points to the entry path of the Sling WebDAV bundle (defaults to |
| <code>/dav/default</code> in the Sling starter). Issues a HTTP |
| Delete for the uninstall goal.</li> |
| |
| <li><b>SlingPostServlet</b>, uses the <a class="externalLink" href="https://sling.apache.org/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html">Sling |
| Post Servlet</a> for deployment (HTTP POST). Make sure that |
| <code>slingUrl</code> points a path which is handled by the Sling |
| POST Servlet (usually below regular Sling root URL).</li> |
| </ol> |
| For more details refer to <a href="bundle-installation.html">Bundle |
| Installation</a>.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>org.apache.sling.maven.bundlesupport.deploy.BundleDeploymentMethod</code></li> |
| |
| <li><b>Since</b>: <code>2.3.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.deploy.method</code></li> |
| |
| <li><b>Default</b>: <code>WebConsole</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfailOnError.3E"></a><b><a name="failOnError"><failOnError></a></b></h4> |
| |
| <div>Determines whether or not to fail the build if the HTTP POST or PUT |
| returns an non-OK response code.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.failOnError</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfileVaultFilterXmlFile.3E"></a><b><a name="fileVaultFilterXmlFile"><fileVaultFilterXmlFile></a></b></h4> |
| |
| <div>Path to META-INF/vault/filter.xml when using FileVault XML |
| filesystem layout.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.filevault.filterxml.file</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfileVaultJcrRootFile.3E"></a><b><a name="fileVaultJcrRootFile"><fileVaultJcrRootFile></a></b></h4> |
| |
| <div>FileVault filesystem layout content root folder.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.filevault.jcr_root.file</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3ChttpConnectTimeoutSec.3E"></a><b><a name="httpConnectTimeoutSec"><httpConnectTimeoutSec></a></b></h4> |
| |
| <div>HTTP connection timeout (in seconds). Determines the timeout until |
| a new connection is fully established. This may also include |
| transport security negotiation exchanges such as <code>SSL</code> |
| or <code>TLS</code> protocol negotiation).</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>int</code></li> |
| |
| <li><b>Since</b>: <code>3.0.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.httpConnectTimeoutSec</code></li> |
| |
| <li><b>Default</b>: <code>10</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3ChttpResponseTimeoutSec.3E"></a><b><a name="httpResponseTimeoutSec"><httpResponseTimeoutSec></a></b></h4> |
| |
| <div>HTTP response timeout (in seconds). Determines the timeout until |
| arrival of a response from the opposite endpoint.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>int</code></li> |
| |
| <li><b>Since</b>: <code>3.0.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.httpResponseTimeoutSec</code></li> |
| |
| <li><b>Default</b>: <code>60</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cpassword.3E"></a><b><a name="password"><password></a></b></h4> |
| |
| <div>The password to authenticate at the running Sling instance.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.password</code></li> |
| |
| <li><b>Default</b>: <code>admin</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cskip.3E"></a><b><a name="skip"><skip></a></b></h4> |
| |
| <div>If set to <code>true</code> Sling File System Resource |
| mount/unmount commands are ignored.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.fsmount.skip</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CslingConsoleUrl.3E"></a><b><a name="slingConsoleUrl"><slingConsoleUrl></a></b></h4> |
| |
| <div>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.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.net.URI</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.console.url</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CslingUrl.3E"></a><b><a name="slingUrl"><slingUrl></a></b></h4> |
| |
| <div>The URL of the running Sling instance. |
| |
| <p>The default is only useful for <b>WebConsole</b> |
| deployment.</p> |
| |
| <p>For <b>WebDAV</b> deployment it is recommended to |
| include the <a class="externalLink" href="https://sling.apache.org/documentation/development/repository-based-development.html#separate-uri-space-webdav">Sling |
| Simple WebDAV servlet root</a>, for instance <a class="externalLink" href="http://localhost:8080/dav/default/libs/sling/install">http://localhost:8080/dav/default/libs/sling/install</a>. |
| Omitting the <code>dav/default</code> segment can lead to conflicts |
| with other servlets.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.net.URI</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>Yes</code></li> |
| |
| <li><b>User Property</b>: <code>sling.url</code></li> |
| |
| <li><b>Default</b>: <code>http://localhost:8080/system/console</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CslingUrlSuffix.3E"></a><b><a name="slingUrlSuffix"><slingUrlSuffix></a></b></h4> |
| |
| <div>An optional url suffix which will be appended to the |
| <code>sling.url</code> for use as the real target url. This allows |
| to configure different target URLs in each POM, while using the |
| same common <code>sling.url</code> in a parent POM (eg. |
| <code>sling.url=http://localhost:8080</code> and |
| <code>sling.urlSuffix=/project/specific/path</code>). This is |
| typically used in conjunction with WebDAV or SlingPostServlet |
| deployment methods.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.urlSuffix</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cuser.3E"></a><b><a name="user"><user></a></b></h4> |
| |
| <div>The user name to authenticate at the running Sling instance.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Since</b>: <code>2.2.0</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>sling.user</code></li> |
| |
| <li><b>Default</b>: <code>admin</code></li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2022 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| <script> |
| if(anchors) { |
| anchors.add(); |
| } |
| </script> |
| </body> |
| </html> |