Built by Maven

sling:install-file

Full name:

org.apache.sling:maven-sling-plugin:2.3.0:install-file

Description:

Install an OSGi bundle to a running Sling instance.

Attributes:

Required Parameters

Name Type Since Description
bundleStart boolean - Whether to start the uploaded bundle or not. Only applies when POSTing to Felix Web Console
Default value is: true.
User property is: sling.bundle.start.
bundleStartLevel String - The start level to set on the installed bundle. If the bundle is already installed and therefore is only updated this parameter is ignored. The parameter is also ignored if the running Sling instance has no StartLevel service (which is unusual actually). Only applies when POSTing to Felix Web Console.
Default value is: 20.
User property is: sling.bundle.startlevel.
failOnError boolean - Determines whether or not to fail the build if the HTTP POST or PUT returns an non-OK response code.
Default value is: true.
User property is: sling.failOnError.
mimeType String - The content type / mime type used for WebDAV or Sling POST deployment.
Default value is: application/java-archive.
User property is: sling.mimeType.
mountByFS boolean - Whether to add the mapping for the Apache Sling File System Resource Provider.
Default value is: false.
User property is: sling.mountByFS.
password String - The password to authenticate at the running Sling instance.
Default value is: admin.
User property is: sling.password.
refreshPackages boolean - Whether to refresh the packages after installing the uploaded bundle. Only applies when POSTing to Felix Web Console
Default value is: true.
User property is: sling.refreshPackages.
slingUrl String - The URL of the running Sling instance. The default is only useful for WebConsole deployment.
Default value is: http://localhost:8080/system/console.
User property is: sling.url.
user String - The user name to authenticate at the running Sling instance.
Default value is: admin.
User property is: sling.user.

Optional Parameters

Name Type Since Description
artifact String - A string of the form groupId:artifactId:version[:packaging[:classifier]].
User property is: sling.artifact.
artifactId String - The artifactId of the artifact to install
User property is: sling.artifactId.
bundleFileName String - The name of the generated JAR file.
User property is: sling.file.
classifier String - The classifier of the artifact to install
User property is: sling.classifier.
deploymentMethod BundleDeploymentMethod - Bundle deployment method. One of the following three values are allowed
  1. WebConsole, uses the Felix Web Console REST API for deployment (HTTP POST). This is the default. Make sure that slingUrl points to the Felix Web Console in that case.
  2. WebDAV, uses WebDAV for deployment (HTTP PUT). Make sure that slingUrl points to the entry path of the Sling WebDAV bundle (usually below regular Sling root URL). Issues a HTTP Delete for the uninstall goal.
  3. SlingPostServlet, uses the Sling Post Servlet for deployment (HTTP POST). Make sure that slingUrl points a path which is handled by the Sling POST Servlet (usually below regular Sling root URL).
This has precedence over the deprecated parameter usePut.
User property is: sling.deploy.method.
groupId String - The groupId of the artifact to install
User property is: sling.groupId.
packaging String - The packaging of the artifact to install
Default value is: jar.
User property is: sling.packaging.
repositoryId String - The id of the repository from which we'll download the artifact
Default value is: temp.
User property is: sling.repoId.
repositoryUrl String - The url of the repository from which we'll download the artifact
User property is: sling.repoUrl.
slingConsoleUrl String - The WebConsole URL of the running Sling instance. This is required for file system provider operations. If not configured the value of slingUrl is used.
User property is: sling.console.url.
slingUrlSuffix String - An optional url suffix which will be appended to the sling.url for use as the real target url. This allows to configure different target URLs in each POM, while using the same common sling.url in a parent POM (eg. sling.url=http://localhost:8080 and sling.urlSuffix=/project/specific/path). This is typically used in conjunction with WebDAV or SlingPostServlet deployment methods.
User property is: sling.urlSuffix.
usePut boolean - Deprecated. Use deploymentMethod instead.
Default value is: false.
User property is: sling.usePut.
version String - The version of the artifact to install
User property is: sling.version.

Parameter Details

artifact:

A string of the form groupId:artifactId:version[:packaging[:classifier]].
  • Type: java.lang.String
  • Required: No
  • User Property: sling.artifact

artifactId:

The artifactId of the artifact to install
  • Type: java.lang.String
  • Required: No
  • User Property: sling.artifactId

bundleFileName:

The name of the generated JAR file.
  • Type: java.lang.String
  • Required: No
  • User Property: sling.file

bundleStart:

Whether to start the uploaded bundle or not. Only applies when POSTing to Felix Web Console
  • Type: boolean
  • Required: Yes
  • User Property: sling.bundle.start
  • Default: true

bundleStartLevel:

The start level to set on the installed bundle. If the bundle is already installed and therefore is only updated this parameter is ignored. The parameter is also ignored if the running Sling instance has no StartLevel service (which is unusual actually). Only applies when POSTing to Felix Web Console.
  • Type: java.lang.String
  • Required: Yes
  • User Property: sling.bundle.startlevel
  • Default: 20

classifier:

The classifier of the artifact to install
  • Type: java.lang.String
  • Required: No
  • User Property: sling.classifier

deploymentMethod:

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

failOnError:

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

groupId:

The groupId of the artifact to install
  • Type: java.lang.String
  • Required: No
  • User Property: sling.groupId

mimeType:

The content type / mime type used for WebDAV or Sling POST deployment.
  • Type: java.lang.String
  • Required: Yes
  • User Property: sling.mimeType
  • Default: application/java-archive

mountByFS:

Whether to add the mapping for the Apache Sling File System Resource Provider.
  • Type: boolean
  • Required: Yes
  • User Property: sling.mountByFS
  • Default: false

packaging:

The packaging of the artifact to install
  • Type: java.lang.String
  • Required: No
  • User Property: sling.packaging
  • Default: jar

password:

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

refreshPackages:

Whether to refresh the packages after installing the uploaded bundle. Only applies when POSTing to Felix Web Console
  • Type: boolean
  • Required: Yes
  • User Property: sling.refreshPackages
  • Default: true

repositoryId:

The id of the repository from which we'll download the artifact
  • Type: java.lang.String
  • Required: No
  • User Property: sling.repoId
  • Default: temp

repositoryUrl:

The url of the repository from which we'll download the artifact
  • Type: java.lang.String
  • Required: No
  • User Property: sling.repoUrl

slingConsoleUrl:

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

slingUrl:

The URL of the running Sling instance. The default is only useful for WebConsole deployment.
  • Type: java.lang.String
  • Required: Yes
  • User Property: sling.url
  • Default: http://localhost:8080/system/console

slingUrlSuffix:

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

usePut:

Deprecated. Use deploymentMethod instead.
If a PUT via WebDAV should be used instead of the standard POST to the Felix Web Console. In the uninstall goal, a HTTP DELETE will be used.
  • Type: boolean
  • Required: No
  • User Property: sling.usePut
  • Default: false

user:

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

version:

The version of the artifact to install
  • Type: java.lang.String
  • Required: No
  • User Property: sling.version