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

 <!DOCTYPE html>
 <!--
  | Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2017-03-09
  | Rendered using Apache Maven Fluido Skin 1.6
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta name="Date-Revision-yyyymmdd" content="20170309" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Apache Sling Maven Plugin for Supporting Bundle Development &#x2013; sling:deploy</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
     <link rel="stylesheet" href="./css/site.css" />
     <link rel="stylesheet" href="./css/print.css" media="print" />
       <script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
       </head>
     <body class="topBarDisabled">
       <div class="container-fluid">
       <div id="banner">
         <div class="pull-left"><div id="bannerLeft"><h2>Apache Sling Maven Plugin for Supporting Bundle Development</h2>
 </div>
 </div>
         <div class="pull-right"></div>
         <div class="clear"><hr/></div>
       </div>

       <div id="breadcrumbs">
         <ul class="breadcrumb">
         <li id="publishDate">Last Published: 2017-03-09<span class="divider">|</span>
 </li>
           <li id="projectVersion">Version: 2.1.10</li>
         </ul>
       </div>
       <div class="row-fluid">
         <div id="leftColumn" class="span2">
           <div 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="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>
           <hr />
           <div id="poweredBy">
               <div class="clear"></div>
               <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>
         </div>
         <div id="bodyColumn"  class="span10" >


     <div class="section">
 <h2><a name="sling:deploy"></a>sling:deploy</h2>

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

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

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

 <div>Deploy a JAR representing an OSGi Bundle. This method posts the
 bundle built by maven 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
 <tt>obr</tt> property.</div>

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

 <ul>

 <li>Requires a Maven project to be executed.</li>

 <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>deploy</tt>.</li>
       </ul>

 <div class="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><b><a href="#failOnError">failOnError</a></b></td>

 <td><tt>boolean</tt></td>

 <td><tt>-</tt></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>: <tt>true</tt>.<br /><b>User property is</b>: <tt>sling.failOnError</tt>.</td>
           </tr>

 <tr class="a">

 <td><b><a href="#jarName">jarName</a></b></td>

 <td><tt>String</tt></td>

 <td><tt>-</tt></td>

 <td>The name of the generated JAR file.<br /><b>User property is</b>: <tt>project.build.finalName</tt>.</td>
           </tr>

 <tr class="b">

 <td><b><a href="#obr">obr</a></b></td>

 <td><tt>String</tt></td>

 <td><tt>-</tt></td>

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

 <tr class="a">

 <td><b><a href="#skip">skip</a></b></td>

 <td><tt>boolean</tt></td>

 <td><tt>-</tt></td>

 <td>Whether to skip this step even though it has been configured in the
 project to be executed. This property may be set by the
 <tt>sling.deploy.skip</tt> comparable to the
 <tt>maven.test.skip</tt> property to prevent running the unit
 tests.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>sling.deploy.skip</tt>.</td>
           </tr>
         </table>
       </div>

 <div class="section">
 <h3><a name="Parameter_Details"></a>Parameter Details</h3>

 <p><b><a name="failOnError">failOnError</a>:</b></p>

 <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>: <tt>boolean</tt></li>

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

 <li><b>User Property</b>: <tt>sling.failOnError</tt></li>

 <li><b>Default</b>: <tt>true</tt></li>
         </ul><hr />
 <p><b><a name="jarName">jarName</a>:</b></p>

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

 <ul>

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

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

 <li><b>User Property</b>: <tt>project.build.finalName</tt></li>
         </ul><hr />
 <p><b><a name="obr">obr</a>:</b></p>

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

 <ul>

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

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

 <li><b>User Property</b>: <tt>obr</tt></li>
         </ul><hr />
 <p><b><a name="skip">skip</a>:</b></p>

 <div>Whether to skip this step even though it has been configured in the
 project to be executed. This property may be set by the
 <tt>sling.deploy.skip</tt> comparable to the
 <tt>maven.test.skip</tt> property to prevent running the unit
 tests.</div>

 <ul>

 <li><b>Type</b>: <tt>boolean</tt></li>

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

 <li><b>User Property</b>: <tt>sling.deploy.skip</tt></li>

 <li><b>Default</b>: <tt>false</tt></li>
         </ul>
       </div>
     </div>


         </div>
       </div>
     </div>
     <hr/>
     <footer>
       <div class="container-fluid">
         <div class="row-fluid">
             <p>Copyright &copy;2007&#x2013;2017
 <a href="https://www.apache.org/">The Apache Software Foundation</a>.
 All rights reserved.</p>
         </div>
         </div>
     </footer>
     </body>
 </html>
	<!DOCTYPE html>
	<!--
	\| Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2017-03-09
	\| Rendered using Apache Maven Fluido Skin 1.6
	-->
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
	<meta charset="UTF-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1.0" />
	<meta name="Date-Revision-yyyymmdd" content="20170309" />
	<meta http-equiv="Content-Language" content="en" />
	<title>Apache Sling Maven Plugin for Supporting Bundle Development – sling:deploy</title>
	<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
	<link rel="stylesheet" href="./css/site.css" />
	<link rel="stylesheet" href="./css/print.css" media="print" />
	<script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
	</head>
	<body class="topBarDisabled">
	<div class="container-fluid">
	<div id="banner">
	<div class="pull-left"><div id="bannerLeft"><h2>Apache Sling Maven Plugin for Supporting Bundle Development</h2>
	</div>
	</div>
	<div class="pull-right"></div>
	<div class="clear"><hr/></div>
	</div>

	<div id="breadcrumbs">
	<ul class="breadcrumb">
	<li id="publishDate">Last Published: 2017-03-09<span class="divider">\|</span>
	</li>
	<li id="projectVersion">Version: 2.1.10</li>
	</ul>
	</div>
	<div class="row-fluid">
	<div id="leftColumn" class="span2">
	<div 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="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>
	<hr />
	<div id="poweredBy">
	<div class="clear"></div>
	<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>
	</div>
	<div id="bodyColumn" class="span10" >


	<div class="section">
	<h2><a name="sling:deploy"></a>sling:deploy</h2>

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

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

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

	<div>Deploy a JAR representing an OSGi Bundle. This method posts the
	bundle built by maven 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
	<tt>obr</tt> property.</div>

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

	<ul>

	<li>Requires a Maven project to be executed.</li>

	<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>deploy</tt>.</li>
	</ul>

	<div class="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><b><a href="#failOnError">failOnError</a></b></td>

	<td><tt>boolean</tt></td>

	<td><tt>-</tt></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>: <tt>true</tt>.<br /><b>User property is</b>: <tt>sling.failOnError</tt>.</td>
	</tr>

	<tr class="a">

	<td><b><a href="#jarName">jarName</a></b></td>

	<td><tt>String</tt></td>

	<td><tt>-</tt></td>

	<td>The name of the generated JAR file.<br /><b>User property is</b>: <tt>project.build.finalName</tt>.</td>
	</tr>

	<tr class="b">

	<td><b><a href="#obr">obr</a></b></td>

	<td><tt>String</tt></td>

	<td><tt>-</tt></td>

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

	<tr class="a">

	<td><b><a href="#skip">skip</a></b></td>

	<td><tt>boolean</tt></td>

	<td><tt>-</tt></td>

	<td>Whether to skip this step even though it has been configured in the
	project to be executed. This property may be set by the
	<tt>sling.deploy.skip</tt> comparable to the
	<tt>maven.test.skip</tt> property to prevent running the unit
	tests.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>sling.deploy.skip</tt>.</td>
	</tr>
	</table>
	</div>

	<div class="section">
	<h3><a name="Parameter_Details"></a>Parameter Details</h3>

	<p><b><a name="failOnError">failOnError</a>:</b></p>

	<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>: <tt>boolean</tt></li>

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

	<li><b>User Property</b>: <tt>sling.failOnError</tt></li>

	<li><b>Default</b>: <tt>true</tt></li>
	</ul><hr />
	<p><b><a name="jarName">jarName</a>:</b></p>

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

	<ul>

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

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

	<li><b>User Property</b>: <tt>project.build.finalName</tt></li>
	</ul><hr />
	<p><b><a name="obr">obr</a>:</b></p>

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

	<ul>

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

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

	<li><b>User Property</b>: <tt>obr</tt></li>
	</ul><hr />
	<p><b><a name="skip">skip</a>:</b></p>

	<div>Whether to skip this step even though it has been configured in the
	project to be executed. This property may be set by the
	<tt>sling.deploy.skip</tt> comparable to the
	<tt>maven.test.skip</tt> property to prevent running the unit
	tests.</div>

	<ul>

	<li><b>Type</b>: <tt>boolean</tt></li>

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

	<li><b>User Property</b>: <tt>sling.deploy.skip</tt></li>

	<li><b>Default</b>: <tt>false</tt></li>
	</ul>
	</div>
	</div>


	</div>
	</div>
	</div>
	<hr/>
	<footer>
	<div class="container-fluid">
	<div class="row-fluid">
	<p>Copyright ©2007–2017
	<a href="https://www.apache.org/">The Apache Software Foundation</a>.
	All rights reserved.</p>
	</div>
	</div>
	</footer>
	</body>
	</html>