jboss-as:deploy

Full name:

org.jboss.as.plugins:jboss-as-maven-plugin:7.1.1.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 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.

Optional Parameters

Name Type Since Description
domain Domain - Indicates if this should be a domain deployment.
filename String - The file name of the application to be deployed.
Default value is: ${project.build.finalName}.${project.packaging}.
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.
hostname String - Specifies the host name of the server where the deployment plan should be executed.
Default value is: localhost.
name String - Specifies the name used for the deployment.
packaging String - Specifies the packaging type.
Default value is: ${project.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,
port int - Specifies the port number the server is listening on.
Default value is: 9999.
skip boolean - Set to true if you want the deployment to be skipped, otherwise false.
Default value is: false.
targetDir File - The target directory the application to be deployed is located.
Default value is: ${project.build.directory}/.
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,

Parameter Details

domain:

Indicates if this should be a domain deployment.
  • Type: org.jboss.as.plugin.deployment.domain.Domain
  • Required: No

filename:

The file name of the application to be deployed.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.finalName}.${project.packaging}

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
  • Expression: ${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
  • Expression: ${deploy.hostname}
  • Default: localhost

name:

Specifies the name used for the deployment.
  • Type: java.lang.String
  • Required: No

packaging:

Specifies the packaging type.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.packaging}

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
  • Expression: ${deploy.password}

port:

Specifies the port number the server is listening on.
  • Type: int
  • Required: No
  • Expression: ${deploy.port}
  • Default: 9999

skip:

Set to true if you want the deployment to be skipped, otherwise false.
  • Type: boolean
  • Required: No
  • Default: false

targetDir:

The target directory the application to be deployed is located.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/

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
  • Expression: ${deploy.username}