jboss-as:start

Full name:

org.jboss.as.plugins:jboss-as-maven-plugin:7.9.Final:start

Description:

Starts a standalone instance of JBoss Application Server 7. The purpose of this goal is to start a JBoss Application Server for testing during the maven lifecycle. This can start a remote server, but the server will be shutdown when the maven process ends.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.

Optional Parameters

Name Type Since Description
artifact String - A string of the form groupId:artifactId:version[:packaging][:classifier]. Any missing portion of the artifact will be replaced with the it's appropriate default property value
User property is: jboss-as.artifact.
artifactId String - The artifactId of the artifact to download. Ignored if artifact artifactId portion is used.
Default value is: jboss-as-dist.
User property is: jboss-as.artifactId.
bundlesPath String - The bundles path to use.
User property is: jboss-as.bundlesPath.
classifier String - The classifier of the artifact to download. Ignored if artifact classifier portion is used.
User property is: jboss-as.classifier.
groupId String - The groupId of the artifact to download. Ignored if artifact groupId portion is used.
Default value is: org.jboss.as.
User property is: jboss-as.groupId.
hostname String - Specifies the host name of the server where the deployment plan should be executed.
Default value is: localhost.
User property is: jboss-as.hostname.
id String - Specifies the id of the server if the username and password is to be retrieved from the settings.xml file
User property is: jboss-as.id.
javaHome String - The JAVA_HOME to use for launching the server.
User property is: java.home.
jbossHome String - The JBoss Application Server's home directory. If not used, JBoss Application Server will be downloaded.
User property is: jboss-as.home.
jvmArgs JavaOpts - A space delimited list of JVM arguments. Default value is -Xms64m -Xmx512m -XX:MaxPermSize=256m -Djava.net.preferIPv4Stack=true -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000
User property is: jboss-as.jvmArgs.
modulesPath ModulesPath - The modules path or paths to use. A single path can be used or multiple paths by enclosing them in a paths element.
User property is: jboss-as.modulesPath.
packaging String - The packaging of the artifact to download. Ignored if artifact packing portion is used.
Default value is: zip.
User property is: jboss-as.packaging.
password String - Specifies the password to use if prompted to authenticate by the server. If no password is specified and the server requests authentication the user will be prompted to supply the password,
User property is: jboss-as.password.
port int - Specifies the port number the server is listening on.
Default value is: 9999.
User property is: jboss-as.port.
propertiesFile String - The path to the system properties file to load.
User property is: jboss-as.propertiesFile.
serverArgs String[] - A space delimited list of server arguments.
User property is: jboss-as.serverArgs.
serverConfig String - The path to the server configuration to use.
User property is: jboss-as.serverConfig.
skip boolean - Indicates whether or not the goal should be skipped.
Default value is: false.
User property is: jboss-as.skip.
startupTimeout long - The arguments to be passed to the server.
Default value is: 60.
User property is: jboss-as.startupTimeout.
timeout int - Specifies the timeout to be used when hitting the host. Default is 5000ms.
User property is: jboss-as.timeout.
username String - Specifies the username to use if prompted to authenticate by the server. If no username is specified and the server requests authentication the user will be prompted to supply the username,
User property is: jboss-as.username.
version String - The version of the artifact to download. Ignored if artifact version portion is used.
Default value is: 7.1.1.Final.
User property is: jboss-as.version.

Parameter Details

artifact:

A string of the form groupId:artifactId:version[:packaging][:classifier]. Any missing portion of the artifact will be replaced with the it's appropriate default property value
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.artifact

artifactId:

The artifactId of the artifact to download. Ignored if artifact artifactId portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.artifactId
  • Default: jboss-as-dist

bundlesPath:

The bundles path to use.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.bundlesPath

classifier:

The classifier of the artifact to download. Ignored if artifact classifier portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.classifier

groupId:

The groupId of the artifact to download. Ignored if artifact groupId portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.groupId
  • Default: org.jboss.as

hostname:

Specifies the host name of the server where the deployment plan should be executed.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.hostname
  • Default: localhost

id:

Specifies the id of the server if the username and password is to be retrieved from the settings.xml file
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.id

javaHome:

The JAVA_HOME to use for launching the server.
  • Type: java.lang.String
  • Required: No
  • User Property: java.home

jbossHome:

The JBoss Application Server's home directory. If not used, JBoss Application Server will be downloaded.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.home

jvmArgs:

A space delimited list of JVM arguments. Default value is -Xms64m -Xmx512m -XX:MaxPermSize=256m -Djava.net.preferIPv4Stack=true -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000
  • Type: org.jboss.as.plugin.server.JavaOpts
  • Required: No
  • User Property: jboss-as.jvmArgs

modulesPath:

The modules path or paths to use. A single path can be used or multiple paths by enclosing them in a paths element.
  • Type: org.jboss.as.plugin.server.ModulesPath
  • Required: No
  • User Property: jboss-as.modulesPath

packaging:

The packaging of the artifact to download. Ignored if artifact packing portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.packaging
  • Default: zip

password:

Specifies the password to use if prompted to authenticate by the server. If no password is specified and the server requests authentication the user will be prompted to supply the password,
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.password

port:

Specifies the port number the server is listening on.
  • Type: int
  • Required: No
  • User Property: jboss-as.port
  • Default: 9999

propertiesFile:

The path to the system properties file to load.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.propertiesFile

serverArgs:

A space delimited list of server arguments.
  • Type: java.lang.String[]
  • Required: No
  • User Property: jboss-as.serverArgs

serverConfig:

The path to the server configuration to use.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.serverConfig

skip:

Indicates whether or not the goal should be skipped.
  • Type: boolean
  • Required: No
  • User Property: jboss-as.skip
  • Default: false

startupTimeout:

The arguments to be passed to the server.
  • Type: long
  • Required: No
  • User Property: jboss-as.startupTimeout
  • Default: 60

timeout:

Specifies the timeout to be used when hitting the host. Default is 5000ms.
  • Type: int
  • Required: No
  • User Property: jboss-as.timeout

username:

Specifies the username to use if prompted to authenticate by the server. If no username is specified and the server requests authentication the user will be prompted to supply the username,
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.username

version:

The version of the artifact to download. Ignored if artifact version portion is used.
  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.version
  • Default: 7.1.1.Final