src/main/jbake/assets/components/sling-maven-plugin-archives/sling-maven-plugin-3.0.2/deploy-file-mojo.html - sling-site - Git at Google

 <!DOCTYPE html>


 <!--
  | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/deploy-file-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 &#x2013; sling:deploy-file</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:deploy-file</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:deploy-file"></a>sling:deploy-file</h2>

 <p><b>Full name</b>:</p>

 <p>org.apache.sling:sling-maven-plugin:3.0.2:deploy-file</p>

 <p><b>This plugin goal has been deprecated</b>:</p>

 <div>Use the OBR goals from the <a class="externalLink" href="https://felix.apache.org/documentation/_attachments/components/bundle-plugin/index.html">maven-bundle-plugin</a>
 instead.</div>

 <p><b>Description</b>:</p>

 <div>Deploy a JAR representing an OSGi Bundle to a Sling OSGi Bundle
 Repository. This method posts the bundle referenced via
 <code>sling.file</code> to an OSGi Bundle Repository accepting the
 bundle. The plugin uses a <i>multipart/format-data</i> POST
 request to just post the file to the URL configured in the
 <code>obr</code> property.</div>

 <p><b>Attributes</b>:</p>

 <ul>

 <li>The goal is not marked as thread-safe and thus does not support parallel builds.</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="#obr">&lt;obr&gt;</a></code></td>

 <td><code>String</code></td>

 <td><code>-</code></td>

 <td>The URL to the OSGi Bundle repository to which the bundle is
 posted, e.g. <code>http://obr.sample.com</code><br /><b>User property is</b>: <code>obr</code>.<br /></td>
           </tr>

 <tr class="a">

 <td align="left"><code><a href="#slingUrl">&lt;slingUrl&gt;</a></code></td>

 <td><code>URI</code></td>

 <td><code>-</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">&lt;bundleFileName&gt;</a></code></td>

 <td><code>String</code></td>

 <td><code>-</code></td>

 <td>The name of the generated JAR file.<br /><b>User property is</b>: <code>sling.file</code>.<br /></td>
           </tr>

 <tr class="a">

 <td align="left"><code><a href="#failOnError">&lt;failOnError&gt;</a></code></td>

 <td><code>boolean</code></td>

 <td><code>-</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="b">

 <td align="left"><code><a href="#httpConnectTimeoutSec">&lt;httpConnectTimeoutSec&gt;</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="a">

 <td align="left"><code><a href="#httpResponseTimeoutSec">&lt;httpResponseTimeoutSec&gt;</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="b">

 <td align="left"><code><a href="#password">&lt;password&gt;</a></code></td>

 <td><code>String</code></td>

 <td><code>-</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="a">

 <td align="left"><code><a href="#slingConsoleUrl">&lt;slingConsoleUrl&gt;</a></code></td>

 <td><code>URI</code></td>

 <td><code>-</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">&lt;slingUrlSuffix&gt;</a></code></td>

 <td><code>String</code></td>

 <td><code>-</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">&lt;user&gt;</a></code></td>

 <td><code>String</code></td>

 <td><code>-</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">&lt;bundleFileName&gt;</a></b></h4>

 <div>The name of the generated JAR file.</div>

 <ul>

 <li><b>Type</b>: <code>java.lang.String</code></li>

 <li><b>Required</b>: <code>No</code></li>

 <li><b>User Property</b>: <code>sling.file</code></li>
         </ul><hr /></section><section>
 <h4><a name="a.3CfailOnError.3E"></a><b><a name="failOnError">&lt;failOnError&gt;</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>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.3ChttpConnectTimeoutSec.3E"></a><b><a name="httpConnectTimeoutSec">&lt;httpConnectTimeoutSec&gt;</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">&lt;httpResponseTimeoutSec&gt;</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.3Cobr.3E"></a><b><a name="obr">&lt;obr&gt;</a></b></h4>

 <div>The URL to the OSGi Bundle repository to which the bundle is
 posted, e.g. <code>http://obr.sample.com</code></div>

 <ul>

 <li><b>Type</b>: <code>java.lang.String</code></li>

 <li><b>Required</b>: <code>Yes</code></li>

 <li><b>User Property</b>: <code>obr</code></li>
         </ul><hr /></section><section>
 <h4><a name="a.3Cpassword.3E"></a><b><a name="password">&lt;password&gt;</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>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.3CslingConsoleUrl.3E"></a><b><a name="slingConsoleUrl">&lt;slingConsoleUrl&gt;</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>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">&lt;slingUrl&gt;</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>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">&lt;slingUrlSuffix&gt;</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>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">&lt;user&gt;</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>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>&#169; 2022
 <a href="https://www.apache.org/">The Apache Software Foundation</a> &vert; <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>
	<!DOCTYPE html>


	<!--
	\| Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/deploy-file-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:deploy-file</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:deploy-file</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:deploy-file"></a>sling:deploy-file</h2>

	<p><b>Full name</b>:</p>

	<p>org.apache.sling:sling-maven-plugin:3.0.2:deploy-file</p>

	<p><b>This plugin goal has been deprecated</b>:</p>

	<div>Use the OBR goals from the <a class="externalLink" href="https://felix.apache.org/documentation/_attachments/components/bundle-plugin/index.html">maven-bundle-plugin</a>
	instead.</div>

	<p><b>Description</b>:</p>

	<div>Deploy a JAR representing an OSGi Bundle to a Sling OSGi Bundle
	Repository. This method posts the bundle referenced via
	<code>sling.file</code> to an OSGi Bundle Repository accepting the
	bundle. The plugin uses a <i>multipart/format-data</i> POST
	request to just post the file to the URL configured in the
	<code>obr</code> property.</div>

	<p><b>Attributes</b>:</p>

	<ul>

	<li>The goal is not marked as thread-safe and thus does not support parallel builds.</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="#obr"><obr></a></code></td>

	<td><code>String</code></td>

	<td><code>-</code></td>

	<td>The URL to the OSGi Bundle repository to which the bundle is
	posted, e.g. <code>http://obr.sample.com</code><br /><b>User property is</b>: <code>obr</code>.<br /></td>
	</tr>

	<tr class="a">

	<td align="left"><code><a href="#slingUrl"><slingUrl></a></code></td>

	<td><code>URI</code></td>

	<td><code>-</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>-</code></td>

	<td>The name of the generated JAR file.<br /><b>User property is</b>: <code>sling.file</code>.<br /></td>
	</tr>

	<tr class="a">

	<td align="left"><code><a href="#failOnError"><failOnError></a></code></td>

	<td><code>boolean</code></td>

	<td><code>-</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="b">

	<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="a">

	<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="b">

	<td align="left"><code><a href="#password"><password></a></code></td>

	<td><code>String</code></td>

	<td><code>-</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="a">

	<td align="left"><code><a href="#slingConsoleUrl"><slingConsoleUrl></a></code></td>

	<td><code>URI</code></td>

	<td><code>-</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>-</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>-</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 name of the generated JAR file.</div>

	<ul>

	<li><b>Type</b>: <code>java.lang.String</code></li>

	<li><b>Required</b>: <code>No</code></li>

	<li><b>User Property</b>: <code>sling.file</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>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.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.3Cobr.3E"></a><b><a name="obr"><obr></a></b></h4>

	<div>The URL to the OSGi Bundle repository to which the bundle is
	posted, e.g. <code>http://obr.sample.com</code></div>

	<ul>

	<li><b>Type</b>: <code>java.lang.String</code></li>

	<li><b>Required</b>: <code>Yes</code></li>

	<li><b>User Property</b>: <code>obr</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>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.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>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>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>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>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>