sling:deploy-file
Full name:
org.apache.sling:sling-maven-plugin:2.4.0:deploy-file
Description:
Deploy a JAR representing an OSGi Bundle to a Sling OSGi Bundle
Repository. This method posts the bundle referenced via
sling.file to an OSGi Bundle Repository accepting the
bundle. The plugin uses a multipart/format-data POST
request to just post the file to the URL configured in the
obr property.
Attributes:
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <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. |
| <obr> | String | - | The URL to the OSGi Bundle repository to which the bundle is
posted, e.g. http://obr.sample.com User property is: obr. |
| <password> | String | - | The password to authenticate at the running Sling instance. Default value is: admin. User property is: sling.password. |
| <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. User property is: sling.file. |
| <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. |
Parameter Details
<bundleFileName>
The name of the generated JAR file.
- Type: java.lang.String
- Required: No
- User Property: sling.file
<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
<obr>
The URL to the OSGi Bundle repository to which the bundle is
posted, e.g. http://obr.sample.com
- Type: java.lang.String
- Required: Yes
- User Property: obr
<password>
The password to authenticate at the running Sling instance.
- Type: java.lang.String
- Required: Yes
- User Property: sling.password
- Default: admin
<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.
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
<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
<user>
The user name to authenticate at the running Sling instance.
- Type: java.lang.String
- Required: Yes
- User Property: sling.user
- Default: admin