Fork me on GitHub

brooklyn:start-server

Full name:

io.brooklyn.maven:brooklyn-maven-plugin:0.3.0:start-server

Description:

Run a Brooklyn server.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
bindAddress String - The IP address of the NIC to bind the Brooklyn Management Console to.
Default value is: 127.0.0.1.
User property is: brooklyn.bindAddress.
launchCommand String - The main command for the process.
Default value is: launch.
User property is: brooklyn.launchCommand.
mainClass String - The main class of the forked process.
Default value is: org.apache.brooklyn.cli.Main.
User property is: brooklyn.main.

Optional Parameters

Name Type Since Description
arguments List - Additional arguments for the server, for example:
  <argument>--catalogInitial</argument>
  <argument>/path/to/custom-catalog.bom</argument>

bindPort String - The port for the Brooklyn REST server to run on. An available port will be chosen at random if this parameter is not given.
User property is: brooklyn.port.
ignoreSkipTests Boolean - Configure the goal to ignore skipTests. Useful if your use of the plugin is outside of the default pre- and post-integration-test phases.
Default value is: false.
User property is: ignoreSkipTests.
javaOptions List - Additional options for the Java process, for example to start a server listening for a remote debugger on port 5005:
  <javaOption>-Xverify:none</javaOption>
  <javaOption>-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005</javaOption>

outputDirOnClasspath Boolean - Whether or not the project's output directory (project.build.outputDirectory) should be included on the server's classpath.
Default value is: true.
password String - The password for the user at the Brooklyn server.
User property is: brooklyn.password.
serverClasspathScope String - The Maven scope to include on the server's classpath. Defaults to test. Setting a value that is not a standard scope will mean there are no additions to the classpath and Brooklyn's main class will not be found. Consider setting testOutputDirOnClasspath to false if the value for this parameter is changed.
Default value is: test.
serverUrlProperty String - The property to set to the newly-started server's URL.
Default value is: brooklyn.server.
skipITs Boolean - Configure the goal to skip execution.
Default value is: false.
User property is: skipITs.
skipTests Boolean - Configure the goal to skip execution.
Default value is: false.
User property is: skipTests.
testOutputDirOnClasspath Boolean - Whether or not the project's test output directory (project.build.testOutputDirectory) should be included on the server's classpath. Configure serverClasspathScope appropriately too.
Default value is: true.
timeout Integer - The duration mojos should wait for actions at Brooklyn to complete.
Default value is: 5.
User property is: brooklyn.timeout.
timeoutUnit TimeUnit - The unit associated with timeout.
Default value is: MINUTES.
User property is: brooklyn.timeoutUnit.
username String - The user to connect to the Brooklyn server as.
User property is: brooklyn.user.
waitForServerUp boolean - Indicates whether the goal should wait for the started server to report itself as running (ascertained by polling its REST API) before returning.
Default value is: true.

Parameter Details

arguments:

Additional arguments for the server, for example:
  <argument>--catalogInitial</argument>
  <argument>/path/to/custom-catalog.bom</argument>
  • Type: java.util.List
  • Required: No

bindAddress:

The IP address of the NIC to bind the Brooklyn Management Console to.
  • Type: java.lang.String
  • Required: Yes
  • User Property: brooklyn.bindAddress
  • Default: 127.0.0.1

bindPort:

The port for the Brooklyn REST server to run on. An available port will be chosen at random if this parameter is not given.
  • Type: java.lang.String
  • Required: No
  • User Property: brooklyn.port

ignoreSkipTests:

Configure the goal to ignore skipTests. Useful if your use of the plugin is outside of the default pre- and post-integration-test phases.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: ignoreSkipTests
  • Default: false

javaOptions:

Additional options for the Java process, for example to start a server listening for a remote debugger on port 5005:
  <javaOption>-Xverify:none</javaOption>
  <javaOption>-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005</javaOption>
  • Type: java.util.List
  • Required: No

launchCommand:

The main command for the process.
  • Type: java.lang.String
  • Required: Yes
  • User Property: brooklyn.launchCommand
  • Default: launch

mainClass:

The main class of the forked process.
  • Type: java.lang.String
  • Required: Yes
  • User Property: brooklyn.main
  • Default: org.apache.brooklyn.cli.Main

outputDirOnClasspath:

Whether or not the project's output directory (project.build.outputDirectory) should be included on the server's classpath.
  • Type: java.lang.Boolean
  • Required: No
  • Default: true

password:

The password for the user at the Brooklyn server.
  • Type: java.lang.String
  • Required: No
  • User Property: brooklyn.password

serverClasspathScope:

The Maven scope to include on the server's classpath. Defaults to test. Setting a value that is not a standard scope will mean there are no additions to the classpath and Brooklyn's main class will not be found. Consider setting testOutputDirOnClasspath to false if the value for this parameter is changed.
  • Type: java.lang.String
  • Required: No
  • Default: test

serverUrlProperty:

The property to set to the newly-started server's URL.
  • Type: java.lang.String
  • Required: No
  • Default: brooklyn.server

skipITs:

Configure the goal to skip execution.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: skipITs
  • Default: false

skipTests:

Configure the goal to skip execution.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: skipTests
  • Default: false

testOutputDirOnClasspath:

Whether or not the project's test output directory (project.build.testOutputDirectory) should be included on the server's classpath. Configure serverClasspathScope appropriately too.
  • Type: java.lang.Boolean
  • Required: No
  • Default: true

timeout:

The duration mojos should wait for actions at Brooklyn to complete.
  • Type: java.lang.Integer
  • Required: No
  • User Property: brooklyn.timeout
  • Default: 5

timeoutUnit:

The unit associated with timeout.
  • Type: java.util.concurrent.TimeUnit
  • Required: No
  • User Property: brooklyn.timeoutUnit
  • Default: MINUTES

username:

The user to connect to the Brooklyn server as.
  • Type: java.lang.String
  • Required: No
  • User Property: brooklyn.user

waitForServerUp:

Indicates whether the goal should wait for the started server to report itself as running (ascertained by polling its REST API) before returning.
  • Type: boolean
  • Required: No
  • Default: true