Fork me on GitHub
Built by Maven

sling:deploy

Full name:

org.apache.sling:sling-maven-plugin:3.0.4:deploy

Deprecated:

Use the OBR goals from the maven-bundle-plugin instead.

Description:

Deploy a JAR representing an OSGi Bundle to a Sling OSGi Bundle Repository. This method posts the bundle built by maven to the OSGi Bundle Repository. The plugin uses a multipart/format-data POST request to just post the file to the URL configured in the obr property.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: deploy.

Required Parameters

Name Type Since Description
<jarName> String - The name of the generated JAR file.
User Property: project.build.finalName
Alias: jarName
<obr> String - The URL to the OSGi Bundle repository to which the bundle is posted, e.g. http://obr.sample.com
User Property: obr
<skip> boolean - Whether to skip this step even though it has been configured in the project to be executed. This property may be set by the sling.deploy.skip comparable to the maven.test.skip property to prevent running the unit tests.
Default: false
User Property: sling.deploy.skip
<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 dav/default segment can lead to conflicts with other servlets.


Default: http://localhost:8080/system/console
User Property: sling.url

Optional 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: true
User Property: 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: 10
User Property: 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: 60
User Property: sling.httpResponseTimeoutSec
<password> String - The password to authenticate at the running Sling instance.
Default: admin
User Property: sling.password
<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: 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: sling.urlSuffix
<user> String - The user name to authenticate at the running Sling instance.
Default: admin
User Property: sling.user

Parameter Details

<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

<jarName>

The name of the generated JAR file.
  • Type: java.lang.String
  • Required: Yes
  • User Property: project.build.finalName
  • Alias: jarName

<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: No
  • User Property: sling.password
  • Default: admin

<skip>

Whether to skip this step even though it has been configured in the project to be executed. This property may be set by the sling.deploy.skip comparable to the maven.test.skip property to prevent running the unit tests.
  • Type: boolean
  • Required: Yes
  • User Property: sling.deploy.skip
  • Default: false

<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

<user>

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