Built by Maven

sling:deploy

Full name:

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

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.
  • Binds by default to the lifecycle phase: deploy.

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.
jarName String - The name of the generated JAR file.
User property is: project.build.finalName.
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.
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 value is: false.
User property is: sling.deploy.skip.
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
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

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

jarName:

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

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

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.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

user:

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