jboss:start-and-wait

Full name:

org.codehaus.mojo:jboss-maven-plugin:1.5.0:start-and-wait

Description:

Starts JBoss and waits until the server is started.

Attributes:

  • Since version: 1.4.

Required Parameters

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

Optional Parameters

Name Type Since Description
hostName String 1.4 The host JBoss is running on.
Default value is: localhost.
namingPort String 1.4 The port for the naming service.
Default value is: 1099.
options String 1.4 Deprecated. use startOptions instead
retry int 1.4 Maximum number of retries to get JBoss JMX MBean connection.
Default value is: 4.
retryWait int 1.4 Wait in ms before each retry of the JBoss JMX MBean connection.
Default value is: 5000.
serverId String 1.4 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 1.4 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.
startOptions String 1.5.0 The set of space separated options to pass to the JBoss "run" command.
timeout int 1.4 Time in ms to start the application server (once JMX MBean connection has been reached).
Default value is: 20000.

Parameter Details

hostName:

The host JBoss is running on.
  • Type: java.lang.String
  • Since: 1.4
  • Required: No
  • Expression: ${jboss.hostname}
  • Default: localhost

jbossHome:

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

namingPort:

The port for the naming service.
  • Type: java.lang.String
  • Since: 1.4
  • Required: No
  • Expression: ${jboss.namingPort}
  • Default: 1099

options:

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

retry:

Maximum number of retries to get JBoss JMX MBean connection.
  • Type: int
  • Since: 1.4
  • Required: No
  • Expression: ${jboss.retry}
  • Default: 4

retryWait:

Wait in ms before each retry of the JBoss JMX MBean connection.
  • Type: int
  • Since: 1.4
  • Required: No
  • Expression: ${jboss.retryWait}
  • Default: 5000

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
  • Since: 1.4
  • 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
  • Since: 1.4
  • Required: No
  • Expression: ${jboss.serverName}
  • Default: default

startOptions:

The set of space separated options to pass to the JBoss "run" command.
  • Type: java.lang.String
  • Since: 1.5.0
  • Required: No
  • Expression: ${jboss.startOptions}

timeout:

Time in ms to start the application server (once JMX MBean connection has been reached).
  • Type: int
  • Since: 1.4
  • Required: No
  • Expression: ${jboss.timeout}
  • Default: 20000