jboss:stop

Full name:

org.codehaus.mojo:jboss-maven-plugin:1.5.0:stop

Description:

Stops JBoss. By default the plugin will return immediately after calling "shutdown" command. The @see #stopWait parameter can be used to force the plugin to wait for a specified time before returning control.

Attributes:

Required Parameters

Name Type Since Description
jbossHome File - The location of JBoss Home. This is a required configuration parameter (unless JBOSS_HOME is set).

Optional Parameters

Name Type Since Description
options String - Deprecated. use stopOptions instead
serverId String - The id of the server configuration found in Maven settings.xml. This configuration will determine the username/password to use when authenticating with the JBoss server. If no value is specified, a default username and password will be used.
serverName String - The name of the configuration profile to use when starting the server. This might be something like "all", "default", or "minimal".
Default value is: default.
stopOptions String 1.5.0 The set of options to pass to the JBoss "run" command.
Default value is: -S.
stopWait int 1.4.1 Wait in ms for server to shutdown before the plugin returns.

Parameter Details

jbossHome:

The location of JBoss Home. This is a required configuration parameter (unless JBOSS_HOME is set).
  • Type: java.io.File
  • Required: Yes
  • Expression: ${env.JBOSS_HOME}

options:

Deprecated. use stopOptions instead
The set of options to pass to the JBoss "run" command.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jboss.options}

serverId:

The id of the server configuration found in Maven settings.xml. This configuration will determine the username/password to use when authenticating with the JBoss server. If no value is specified, a default username and password will be used.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jboss.serverId}

serverName:

The name of the configuration profile to use when starting the server. This might be something like "all", "default", or "minimal".
  • Type: java.lang.String
  • Required: No
  • Expression: ${jboss.serverName}
  • Default: default

stopOptions:

The set of options to pass to the JBoss "run" command.
  • Type: java.lang.String
  • Since: 1.5.0
  • Required: No
  • Expression: ${jboss.stopOptions}
  • Default: -S

stopWait:

Wait in ms for server to shutdown before the plugin returns.
  • Type: int
  • Since: 1.4.1
  • Required: No
  • Expression: ${jboss.stopWait}