jboss-as:undeploy-artifact

Full name:

org.jboss.as.plugins:jboss-as-maven-plugin:7.9.Final:undeploy-artifact

Description:

Undeploys (removes) an arbitrary artifact to the JBoss application server

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Optional Parameters

Name Type Since Description
afterDeployment Commands - Executions to run after the deployment
artifactId String - The artifact to deploys artifactId
beforeDeployment Commands - Commands to run before the deployment
domain Domain - Specifies the configuration for a domain server.
groupId String - The artifact to deploys 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.
ignoreMissingDeployment boolean - Indicates whether undeploy should ignore the undeploy operation if the deployment does not exist.
Default value is: true.
User property is: undeploy.ignoreMissingDeployment.
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.
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

artifactId:

The artifact to deploys artifactId
  • Type: java.lang.String
  • Required: No

beforeDeployment:

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

domain:

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

groupId:

The artifact to deploys groupId
  • Type: java.lang.String
  • Required: No

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

ignoreMissingDeployment:

Indicates whether undeploy should ignore the undeploy operation if the deployment does not exist.
  • Type: boolean
  • Required: No
  • User Property: undeploy.ignoreMissingDeployment
  • Default: true

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

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