Google Git
Sign in
apache / sling-site / 9a6972708bb3a708197845f4ad9cca6249f7ad8d / . / src / main / jbake / assets / components / sling-maven-plugin / apidocs / org / apache / sling / maven / bundlesupport / BundleInstallMojo.html
blob: 583c8741b4cb4ac33bad277a71e2402a40ca58d1 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>BundleInstallMojo (Apache Sling Maven Plugin 3.0.2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BundleInstallMojo (Apache Sling Maven Plugin 3.0.2 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BundleInstallMojo.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sling.maven.bundlesupport</a></div>
<h2 title="Class BundleInstallMojo" class="title">Class BundleInstallMojo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.maven.plugin.AbstractMojo</li>
<li>
<ul class="inheritance">
<li>org.apache.sling.maven.bundlesupport.BundleInstallMojo</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd>
</dl>
<hr>
<pre>@Mojo(name="install",
defaultPhase=INSTALL)
public class <span class="typeNameLabel">BundleInstallMojo</span>
extends org.apache.maven.plugin.AbstractMojo</pre>
<div class="block">Install the project's artifact to a running Sling instance (in case it is an OSGi bundle).
It uses the first valid OSGi bundle file for deployment from the primary artifact and all secondary ones.
For details refer to <a href="bundle-installation.html">Bundle Installation</a>.
To install an arbitrary bundle not attached to the current Maven project use goal <a href="install-file-mojo.html">install-file</a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="deploy/BundleDeploymentMethod.html" title="enum in org.apache.sling.maven.bundlesupport.deploy">BundleDeploymentMethod</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deploymentMethod">deploymentMethod</a></span></code></th>
<td class="colLast">
<div class="block">Bundle deployment method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#failOnError">failOnError</a></span></code></th>
<td class="colLast">
<div class="block">Determines whether or not to fail the build if
the HTTP POST or PUT returns an non-OK response code.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mimeType">mimeType</a></span></code></th>
<td class="colLast">
<div class="block">The content type / mime type used for WebDAV or Sling POST deployment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#project">project</a></span></code></th>
<td class="colLast">
<div class="block">The Maven project.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.aether.RepositorySystemSession</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#repoSession">repoSession</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;org.eclipse.aether.repository.RemoteRepository&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#repositories">repositories</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.aether.RepositorySystem</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#repoSystem">repoSystem</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#slingConsoleUrl">slingConsoleUrl</a></span></code></th>
<td class="colLast">
<div class="block">The WebConsole URL of the running Sling instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#slingUrl">slingUrl</a></span></code></th>
<td class="colLast">
<div class="block">The URL of the running Sling instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#slingUrlSuffix">slingUrlSuffix</a></span></code></th>
<td class="colLast">
<div class="block">An optional url suffix which will be appended to the <code>sling.url</code>
for use as the real target url.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#usePut">usePut</a></span></code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#deploymentMethod"><code>deploymentMethod</code></a> instead.</div>
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.maven.plugin.Mojo">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.maven.plugin.Mojo</h3>
<code>ROLE</code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">BundleInstallMojo</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTrailingSlash(java.net.URI)">addTrailingSlash</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;targetURL)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure(org.apache.hc.client5.http.impl.classic.CloseableHttpClient,java.net.URI,java.io.File)">configure</a></span>&#8203;(org.apache.hc.client5.http.impl.classic.CloseableHttpClient&nbsp;httpClient,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;consoleTargetURL,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a>&nbsp;file)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute()">execute</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBundleFileName()">getBundleFileName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBundleSymbolicName(java.io.File)">getBundleSymbolicName</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a>&nbsp;jarFile)</code></th>
<td class="colLast">
<div class="block">Returns the symbolic name of the given bundle.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConsoleTargetURL()">getConsoleTargetURL</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="deploy/BundleDeploymentMethod.html" title="enum in org.apache.sling.maven.bundlesupport.deploy">BundleDeploymentMethod</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeploymentMethod()">getDeploymentMethod</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieve the bundle deployment method matching the configuration.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected org.apache.hc.client5.http.impl.classic.CloseableHttpClient</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpClient()">getHttpClient</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected org.apache.hc.client5.http.config.RequestConfig.Builder</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestConfigBuilder()">getRequestConfigBuilder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTargetURL()">getTargetURL</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveArtifact(org.eclipse.aether.artifact.Artifact)">resolveArtifact</a></span>&#8203;(org.eclipse.aether.artifact.Artifact&nbsp;artifact)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.maven.plugin.AbstractMojo</h3>
<code>getLog, getPluginContext, setLog, setPluginContext</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="usePut">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usePut</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
@Parameter(property="sling.usePut",
defaultValue="false")
protected&nbsp;boolean usePut</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#deploymentMethod"><code>deploymentMethod</code></a> instead.</div>
</div>
<div class="block">If a PUT via WebDAV should be used instead of the standard POST to the
Felix Web Console. In the <code>uninstall</code> goal, a HTTP DELETE will be
used.</div>
</li>
</ul>
<a id="deploymentMethod">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deploymentMethod</h4>
<pre>@Parameter(property="sling.deploy.method")
protected&nbsp;<a href="deploy/BundleDeploymentMethod.html" title="enum in org.apache.sling.maven.bundlesupport.deploy">BundleDeploymentMethod</a> deploymentMethod</pre>
<div class="block">Bundle deployment method. One of the following three values are allowed
<ol>
<li><strong>WebConsole</strong>, uses the <a 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 <a href="#slingUrl"><code>slingUrl</code></a> points to the Felix Web Console in that case.</li>
<li><strong>WebDAV</strong>, uses <a href="https://sling.apache.org/documentation/development/repository-based-development.html">
WebDAV</a> for deployment (HTTP PUT). Make sure that <a href="#slingUrl"><code>slingUrl</code></a> 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><strong>SlingPostServlet</strong>, uses the
<a 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 <a href="#slingUrl"><code>slingUrl</code></a> 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>.
This has precedence over the deprecated parameter <a href="#usePut"><code>usePut</code></a>.
If nothing is set the default is either <code>WebConsole</code> or <code>WebDAV</code> (when <a href="#usePut"><code>usePut</code></a> is <code>true</code>).</div>
</li>
</ul>
<a id="mimeType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mimeType</h4>
<pre>@Parameter(property="sling.mimeType",
defaultValue="application/java-archive")
protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> mimeType</pre>
<div class="block">The content type / mime type used for WebDAV or Sling POST deployment.</div>
</li>
</ul>
<a id="project">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>project</h4>
<pre>@Parameter(defaultValue="${project}",
required=true,
readonly=true)
protected&nbsp;org.apache.maven.project.MavenProject project</pre>
<div class="block">The Maven project.</div>
</li>
</ul>
<a id="slingUrl">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slingUrl</h4>
<pre>@Parameter(property="sling.url",
defaultValue="http://localhost:8080/system/console",
required=true)
protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> slingUrl</pre>
<div class="block">The URL of the running Sling instance.
<p>The default is only useful for <strong>WebConsole</strong> deployment.</p>
<p>For <strong>WebDAV</strong> deployment it is recommended to include the <a href="https://sling.apache.org/documentation/development/repository-based-development.html#separate-uri-space-webdav">Sling Simple WebDAV servlet root</a>, for instance <a 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>
</li>
</ul>
<a id="slingConsoleUrl">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slingConsoleUrl</h4>
<pre>@Parameter(property="sling.console.url")
protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> slingConsoleUrl</pre>
<div class="block">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>
</li>
</ul>
<a id="slingUrlSuffix">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slingUrlSuffix</h4>
<pre>@Parameter(property="sling.urlSuffix")
protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> slingUrlSuffix</pre>
<div class="block">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>
</li>
</ul>
<a id="failOnError">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failOnError</h4>
<pre>@Parameter(property="sling.failOnError",
defaultValue="true")
protected&nbsp;boolean failOnError</pre>
<div class="block">Determines whether or not to fail the build if
the HTTP POST or PUT returns an non-OK response code.</div>
</li>
</ul>
<a id="repoSystem">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>repoSystem</h4>
<pre>@Component
protected&nbsp;org.eclipse.aether.RepositorySystem repoSystem</pre>
</li>
</ul>
<a id="repoSession">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>repoSession</h4>
<pre>@Parameter(defaultValue="${repositorySystemSession}",
readonly=true,
required=true)
protected&nbsp;org.eclipse.aether.RepositorySystemSession repoSession</pre>
</li>
</ul>
<a id="repositories">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>repositories</h4>
<pre>@Parameter(defaultValue="${project.remoteProjectRepositories}",
readonly=true,
required=true)
protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;org.eclipse.aether.repository.RemoteRepository&gt; repositories</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BundleInstallMojo</h4>
<pre>public&nbsp;BundleInstallMojo()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;execute()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>execute</code>&nbsp;in interface&nbsp;<code>org.apache.maven.plugin.Mojo</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="getBundleFileName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBundleFileName</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a>&nbsp;getBundleFileName()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="configure(org.apache.hc.client5.http.impl.classic.CloseableHttpClient,java.net.URI,java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;configure&#8203;(org.apache.hc.client5.http.impl.classic.CloseableHttpClient&nbsp;httpClient,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;consoleTargetURL,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a>&nbsp;file)
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="getDeploymentMethod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeploymentMethod</h4>
<pre class="methodSignature">protected&nbsp;<a href="deploy/BundleDeploymentMethod.html" title="enum in org.apache.sling.maven.bundlesupport.deploy">BundleDeploymentMethod</a>&nbsp;getDeploymentMethod()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Retrieve the bundle deployment method matching the configuration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>bundle deployment method matching the plugin configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - Exception</dd>
</dl>
</li>
</ul>
<a id="getBundleSymbolicName(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBundleSymbolicName</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getBundleSymbolicName&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a>&nbsp;jarFile)</pre>
<div class="block">Returns the symbolic name of the given bundle. If the
<code>jarFile</code> does not contain a manifest with a
<code>Bundle-SymbolicName</code> header <code>null</code> is
returned. Otherwise the value of the <code>Bundle-SymbolicName</code>
header is returned.
<p>
This method may also be used to check whether the file is a bundle at all
as it is assumed, that only if the file contains an OSGi bundle will the
<code>Bundle-SymbolicName</code> manifest header be set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jarFile</code> - The file providing the bundle whose symbolic name is
requested.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The bundle's symbolic name from the
<code>Bundle-SymbolicName</code> manifest header or
<code>null</code> if no manifest exists in the file or the
header is not contained in the manifest. However, if
<code>null</code> is returned, the file may be assumed to not
contain an OSGi bundle.</dd>
</dl>
</li>
</ul>
<a id="getTargetURL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetURL</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;getTargetURL()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the combination of <code>sling.url</code> and <code>sling.urlSuffix</code>. Always ends with "/".</dd>
</dl>
</li>
</ul>
<a id="getConsoleTargetURL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConsoleTargetURL</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;getConsoleTargetURL()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the combination of <code>sling.console.url</code> and <code>sling.urlSuffix</code>. Always ends with "/".</dd>
</dl>
</li>
</ul>
<a id="addTrailingSlash(java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTrailingSlash</h4>
<pre class="methodSignature">public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;addTrailingSlash&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;targetURL)</pre>
</li>
</ul>
<a id="getHttpClient()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHttpClient</h4>
<pre class="methodSignature">protected&nbsp;org.apache.hc.client5.http.impl.classic.CloseableHttpClient&nbsp;getHttpClient()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Get the http client</dd>
</dl>
</li>
</ul>
<a id="getRequestConfigBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestConfigBuilder</h4>
<pre class="methodSignature">protected&nbsp;org.apache.hc.client5.http.config.RequestConfig.Builder&nbsp;getRequestConfigBuilder()</pre>
</li>
</ul>
<a id="resolveArtifact(org.eclipse.aether.artifact.Artifact)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resolveArtifact</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a>&nbsp;resolveArtifact&#8203;(org.eclipse.aether.artifact.Artifact&nbsp;artifact)
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BundleInstallMojo.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>