Fork me on GitHub
Built by Maven

feature-launcher:start

Full name:

org.apache.sling:feature-launcher-maven-plugin:1.0.2:start

Description:

Start one or multiple Sling Feature(s).

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: pre-integration-test.

Required Parameters

Name Type Since Description
<featureLauncherVersion> String - The version of the Sling Feature Launcher to use.
Default: 1.3.4
<launches> List<Launch> - List of Launch objects to start. Each is having the following format: 

<id>...</id> <!-- the id of the launch, must be unique within the list, is mandatory-->
<feature>...</feature> <!-- the Maven coordinates of the feature model, mandatory unless featureFile is used  -->
<featureFile>...</featureFile> <!-- the path to the feature model, mandatory unless feature is used -->
<launcherArguments> <!-- additional arguments to pass to the launcher -->
  <frameworkProperties>
    <org.osgi.service.http.port>8090</org.osgi.service.http.port>
  </framweworkProperties>
  ..
</launcherArguments>
<repositoryUrls>
   <repositoryUrl>file://.../artifacts</repositoryUrl>
   <repositoryUrl>https://repo1.maven.org/maven2/</repositoryUrl>
</repositoryUrls>
<environmentVariables><!--additional environment variables to pass to the launcher -->
 <JAVA_HOME>...</JAVA_HOME>
</environmentVariables>

If no repository URLs are configured the following defaults are used, in order:

  • The local Maven repository
  • The Maven Central repository
  • The Apache Snapshots repository

<outputDirectory> File - The directory in which the features are launched (below its child directory launchers/<launch-id>).
Default: ${project.build.directory}
User Property: outputDir
<trackProcess> boolean - Whether to track the Sling instance process and forcibly stop it when the build ends, when it was not stopped properly.
Default: true

Parameter Details

<featureLauncherVersion>

The version of the Sling Feature Launcher to use.
  • Type: java.lang.String
  • Required: Yes
  • Default: 1.3.4

<launches>

List of Launch objects to start. Each is having the following format: 

<id>...</id> <!-- the id of the launch, must be unique within the list, is mandatory-->
<feature>...</feature> <!-- the Maven coordinates of the feature model, mandatory unless featureFile is used  -->
<featureFile>...</featureFile> <!-- the path to the feature model, mandatory unless feature is used -->
<launcherArguments> <!-- additional arguments to pass to the launcher -->
  <frameworkProperties>
    <org.osgi.service.http.port>8090</org.osgi.service.http.port>
  </framweworkProperties>
  ..
</launcherArguments>
<repositoryUrls>
   <repositoryUrl>file://.../artifacts</repositoryUrl>
   <repositoryUrl>https://repo1.maven.org/maven2/</repositoryUrl>
</repositoryUrls>
<environmentVariables><!--additional environment variables to pass to the launcher -->
 <JAVA_HOME>...</JAVA_HOME>
</environmentVariables>

If no repository URLs are configured the following defaults are used, in order:

  • The local Maven repository
  • The Maven Central repository
  • The Apache Snapshots repository

<outputDirectory>

The directory in which the features are launched (below its child directory launchers/<launch-id>).
  • Type: java.io.File
  • Required: Yes
  • User Property: outputDir
  • Default: ${project.build.directory}

<trackProcess>

Whether to track the Sling instance process and forcibly stop it when the build ends, when it was not stopped properly.
  • Type: boolean
  • Required: Yes
  • Default: true