jboss-as:run

Full name:

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

Description:

Starts a standalone instance of JBoss Application Server 7 and deploys the application to the server. This goal will block until cancelled or a shutdown is invoked from a management client.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Invokes the execution of the lifecycle phase package prior to executing itself.

Optional Parameters

Name Type Since Description
afterDeployment Commands - Executions to run after the deployment
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.
beforeDeployment Commands - Commands to run before the deployment
bundlesPath String - The bundles path to use.
User property is: jboss-as.bundlesPath.
checkPackaging boolean - By default certain package types are ignored when processing, e.g. maven-project and pom. Set this value to false if this check should be bypassed.
Default value is: true.
User property is: jboss-as.checkPackaging.
classifier String - The classifier of the artifact to download. Ignored if artifact classifier portion is used.
User property is: jboss-as.classifier.
deployEnabled boolean - Specifies whether the deployed application should be automatically enabled or not.

If enabled, the deploy goal will automatically run the application in the target container. If disabled, the content will be uploaded but not deployed.

Note that if an application of the same name is already running and the force parameter is true, the application will be enabled automatically, even if this parameter is false (disabled). That is, an enabled application will not be disabled by re-deployment. The converse is true, i.e. a disabled application may be enabled by a forced deployment of the same content where this parameter is true.


Default value is: true.
User property is: deploy.enabled.
domain Domain - Specifies the configuration for a domain server.
filename String - The file name of the application to be deployed.

The filename property does have a default of ${project.build.finalName}.${project.packaging}. The default value is not injected as it normally would be due to packaging types like ejb that result in a file with a .jar extension rather than an .ejb extension.


User property is: jboss-as.deployment.filename.
force boolean - Specifies whether force mode should be used or not.

If force mode is disabled, the deploy goal will cause a build failure if the application being deployed already exists.
Default value is: true.
User property is: deploy.force.
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.
name String - Specifies the name used for the deployment. Note that the name should end in a valid deployment extension.

Examples:

  • <name>example.war</name>
  • <name>example.ear</name>



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.
targetDir File - The target directory the application to be deployed is located.
Default value is: ${project.build.directory}/.
User property is: jboss-as.deployment.targetDir.
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

afterDeployment:

Executions to run after the deployment
  • Type: org.jboss.as.plugin.cli.Commands
  • Required: No

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

beforeDeployment:

Commands to run before the deployment
  • Type: org.jboss.as.plugin.cli.Commands
  • Required: No

bundlesPath:

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

checkPackaging:

By default certain package types are ignored when processing, e.g. maven-project and pom. Set this value to false if this check should be bypassed.
  • Type: boolean
  • Required: No
  • User Property: jboss-as.checkPackaging
  • Default: true

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

deployEnabled:

Specifies whether the deployed application should be automatically enabled or not.

If enabled, the deploy goal will automatically run the application in the target container. If disabled, the content will be uploaded but not deployed.

Note that if an application of the same name is already running and the force parameter is true, the application will be enabled automatically, even if this parameter is false (disabled). That is, an enabled application will not be disabled by re-deployment. The converse is true, i.e. a disabled application may be enabled by a forced deployment of the same content where this parameter is true.

  • Type: boolean
  • Required: No
  • User Property: deploy.enabled
  • Default: true

domain:

Specifies the configuration for a domain server.
  • Type: org.jboss.as.plugin.deployment.domain.Domain
  • Required: No

filename:

The file name of the application to be deployed.

The filename property does have a default of ${project.build.finalName}.${project.packaging}. The default value is not injected as it normally would be due to packaging types like ejb that result in a file with a .jar extension rather than an .ejb extension.

  • Type: java.lang.String
  • Required: No
  • User Property: jboss-as.deployment.filename

force:

Specifies whether force mode should be used or not.

If force mode is disabled, the deploy goal will cause a build failure if the application being deployed already exists.
  • Type: boolean
  • Required: No
  • User Property: deploy.force
  • Default: true

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

name:

Specifies the name used for the deployment. Note that the name should end in a valid deployment extension.

Examples:

  • <name>example.war</name>
  • <name>example.ear</name>


  • Type: java.lang.String
  • Required: No

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

targetDir:

The target directory the application to be deployed is located.
  • Type: java.io.File
  • Required: No
  • User Property: jboss-as.deployment.targetDir
  • Default: ${project.build.directory}/

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