jboss-as:deploy

Full name:

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

Description:

Deploys the application to the JBoss Application Server. If force is set to true, the server is queried to see if the application already exists. If the application already exists, the application is redeployed instead of deployed. If the application does not exist the application is deployed as normal. If force is set to false and the application has already been deployed to the server, an error will occur and the deployment will fail.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • 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
beforeDeployment Commands - Commands to run before the deployment
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.
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.
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.
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>
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.
skip boolean - Indicates whether or not the goal should be skipped.
Default value is: false.
User property is: jboss-as.skip.
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.

Parameter Details

afterDeployment:

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

beforeDeployment:

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

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

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

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

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

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

skip:

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

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