sling:uninstall
Full name:
org.apache.sling:sling-maven-plugin:2.4.0:uninstall
Description:
Uninstall an OSGi bundle from a running Sling instance. The plugin
places by default an HTTP POST request to
Felix
Web Console to uninstall the bundle. It's also possible to use
HTTP DELETE leveraging the
WebDAV
bundle from Sling. or the
Sling
POST servlet to uninstall the bundle. The chosen method depends
on the parameter
deploymentMethod.
Attributes:
- Requires a Maven project to be executed.
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.
For WebDAV deployment it is recommended to
include the Sling Simple WebDAV servlet root, for instance http://localhost:8080/dav/default/libs/sling/install.
Omitting the dav/default segment can lead to conflicts
with other servlets. 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 |
<bundleFileName> |
String |
- |
The name of the generated JAR file. Default value is: ${project.build.directory}/${project.build.finalName}.jar. User property is: sling.file.
|
<deploymentMethod> |
BundleDeploymentMethod |
- |
Bundle deployment method. One of the following three values are
allowed
- 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.
- WebDAV, uses WebDAV
for deployment (HTTP PUT). Make sure that slingUrl
points to the entry path of the Sling WebDAV bundle (defaults to
/dav/default in the Sling starter). Issues a HTTP Delete
for the uninstall goal.
- 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.
|
<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.
|
Parameter Details
The name of the generated JAR file.
- Type: java.lang.String
- Required: No
- User Property: sling.file
- Default: ${project.build.directory}/${project.build.finalName}.jar
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
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
Bundle deployment method. One of the following three values are
allowed
- 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.
- WebDAV, uses WebDAV
for deployment (HTTP PUT). Make sure that slingUrl
points to the entry path of the Sling WebDAV bundle (defaults to
/dav/default in the Sling starter). Issues a HTTP Delete
for the uninstall goal.
- 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
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
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
- Type: boolean
- Required: Yes
- User Property: sling.mountByFS
- Default: false
The password to authenticate at the running Sling instance.
- Type: java.lang.String
- Required: Yes
- User Property: sling.password
- Default: admin
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
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
The URL of the running Sling instance.
The default is only useful for WebConsole
deployment.
For WebDAV deployment it is recommended to
include the Sling Simple WebDAV servlet root, for instance http://localhost:8080/dav/default/libs/sling/install.
Omitting the dav/default segment can lead to conflicts
with other servlets.
- Type: java.lang.String
- Required: Yes
- User Property: sling.url
- Default: http://localhost:8080/system/console
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
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
The user name to authenticate at the running Sling instance.
- Type: java.lang.String
- Required: Yes
- User Property: sling.user
- Default: admin