sling:uninstall
Full name:
org.apache.sling:sling-maven-plugin:3.0.2:uninstall
Description:
Uninstall an OSGi bundle from a running Sling instance. For details
refer to Bundle
Uninstallation.
Attributes:
- Requires a Maven project to be executed.
- The goal is not marked as thread-safe and thus does not support parallel builds.
Required Parameters
Name | Type | Since | Description |
---|---|---|---|
<slingUrl> |
URI |
- |
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 Default value is: http://localhost:8080/system/console .User property is: sling.url . |
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
<bundleFileName> |
File |
- |
Deprecated. Use bundleName insteadDefault value is: ${project.build.directory}/${project.build.finalName}.jar .User property is: sling.file . |
<bundleName> |
String |
- |
The bundles's file/resource name without path (for all
deploymentMethod s except for WebConsole )
or its symbolic name. If this parameter is set, it takes precedence
over bundleFileName .User property is: sling.bundle.name . |
<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 . |
<deploymentMethod> |
BundleDeploymentMethod |
- |
Bundle deployment method. One of the following three values are
allowed
usePut . If nothing is set the default is either
WebConsole or WebDAV (when
usePut is true ).User property is: sling.deploy.method . |
<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 . |
<httpConnectTimeoutSec> |
int |
3.0.0 |
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 SSL
or TLS protocol negotiation).Default value is: 10 .User property is: sling.httpConnectTimeoutSec . |
<httpResponseTimeoutSec> |
int |
3.0.0 |
HTTP response timeout (in seconds). Determines the timeout until
arrival of a response from the opposite endpoint. Default value is: 60 .User property is: sling.httpResponseTimeoutSec . |
<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 (for install)/remove (for uninstall) the mapping for
the Apache
Sling File System Resource Provider for the bundle's
initial content. This parameter must not be true
with bundles resolved from the Maven repository.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 . |
<slingConsoleUrl> |
URI |
- |
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 . |
<user> |
String |
- |
The user name to authenticate at the running Sling instance. Default value is: admin .User property is: sling.user . |
Parameter Details
<bundleFileName>
Deprecated. Use
bundleName
insteadThe path of bundle file to uninstall. The file is only used to
determine the file name or bundle symbolic name. This parameter is
only effective if
bundleName
is not set.- Type:
java.io.File
- Required:
No
- User Property:
sling.file
- Default:
${project.build.directory}/${project.build.finalName}.jar
<bundleName>
The bundles's file/resource name without path (for all
deploymentMethod
s except for WebConsole
)
or its symbolic name. If this parameter is set, it takes precedence
over bundleFileName
.- Type:
java.lang.String
- Required:
No
- User Property:
sling.bundle.name
<bundleStart>
Whether to start the uploaded bundle or not. Only applies when
POSTing to Felix Web Console
- Type:
boolean
- Required:
No
- 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:
No
- User Property:
sling.bundle.startlevel
- Default:
20
<deploymentMethod>
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).
usePut
. If nothing is set the default is either
WebConsole
or WebDAV
(when
usePut
is true
).- 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:
No
- User Property:
sling.failOnError
- Default:
true
<httpConnectTimeoutSec>
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
SSL
or TLS
protocol negotiation).- Type:
int
- Since:
3.0.0
- Required:
No
- User Property:
sling.httpConnectTimeoutSec
- Default:
10
<httpResponseTimeoutSec>
HTTP response timeout (in seconds). Determines the timeout until
arrival of a response from the opposite endpoint.
- Type:
int
- Since:
3.0.0
- Required:
No
- User Property:
sling.httpResponseTimeoutSec
- Default:
60
<mimeType>
The content type / mime type used for WebDAV or Sling POST
deployment.
- Type:
java.lang.String
- Required:
No
- User Property:
sling.mimeType
- Default:
application/java-archive
<mountByFS>
Whether to add (for install)/remove (for uninstall) the mapping for
the Apache
Sling File System Resource Provider for the bundle's
initial content. This parameter must not be
true
with bundles resolved from the Maven repository.- Type:
boolean
- Required:
No
- User Property:
sling.mountByFS
- Default:
false
<password>
The password to authenticate at the running Sling instance.
- Type:
java.lang.String
- Required:
No
- 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:
No
- User Property:
sling.refreshPackages
- Default:
true
<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.net.URI
- Required:
No
- User Property:
sling.console.url
<slingUrl>
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.net.URI
- 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:
No
- User Property:
sling.user
- Default:
admin