Fork me on GitHub

brooklyn:stop-server

Full name:

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

Description:

Instruct a Brooklyn server to shut down. If the server was started by the StartBrooklynMojo start goal the plugin will wait for the forked process to exit.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: post-integration-test.

Optional Parameters

Name Type Since Description
forceShutdownOnError Boolean - Instruct the Brooklyn server to force its shutdown even when errors were thrown while terminating applications.
Default value is: true.
User property is: brooklyn.forceShutdown.
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.
password String - The password for the user at the Brooklyn server.
User property is: brooklyn.password.
pollPeriod Integer - The period that should be waited between successive polls of the Brooklyn server.
Default value is: 5.
User property is: brooklyn.pollPeriod.
pollUnit TimeUnit - The unit associated with pollPeriod.
Default value is: SECONDS.
User property is: brooklyn.pollUnit.
server URL - The URL of the Brooklyn server to communicate with.
User property is: brooklyn.server.
shutdownTimeout String - The maximum time to wait for the server to shutdown. Defaults to forever.
Default value is: 0.
User property is: brooklyn.timeout.
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.
stopApplications Boolean - Instruct the Brooklyn server to terminate all running applications before terminating itself.
Default value is: true.
User property is: brooklyn.stopApplications.
tearDownOnFailure boolean - Sets whether servers started by StartBrooklynMojo should be stopped if execution of the goal fails.
Default value is: true.
User property is: brooklyn.tearDownOnFailure.
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.

Parameter Details

forceShutdownOnError:

Instruct the Brooklyn server to force its shutdown even when errors were thrown while terminating applications.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: brooklyn.forceShutdown
  • Default: true

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

password:

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

pollPeriod:

The period that should be waited between successive polls of the Brooklyn server.
  • Type: java.lang.Integer
  • Required: No
  • User Property: brooklyn.pollPeriod
  • Default: 5

pollUnit:

The unit associated with pollPeriod.
  • Type: java.util.concurrent.TimeUnit
  • Required: No
  • User Property: brooklyn.pollUnit
  • Default: SECONDS

server:

The URL of the Brooklyn server to communicate with.
  • Type: java.net.URL
  • Required: No
  • User Property: brooklyn.server

shutdownTimeout:

The maximum time to wait for the server to shutdown. Defaults to forever.
  • Type: java.lang.String
  • Required: No
  • User Property: brooklyn.timeout
  • Default: 0

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

stopApplications:

Instruct the Brooklyn server to terminate all running applications before terminating itself.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: brooklyn.stopApplications
  • Default: true

tearDownOnFailure:

Sets whether servers started by StartBrooklynMojo should be stopped if execution of the goal fails.
  • Type: boolean
  • Required: No
  • User Property: brooklyn.tearDownOnFailure
  • 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