Built by Maven

sling:deploy

Full name:

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

Description:

Deploy a JAR representing an OSGi Bundle. This method posts the bundle built by maven 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:

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

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

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