jboss-as:undeploy-artifact

Full name:

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

Description:

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

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
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.
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.
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 - Set to true if you want the deployment to be skipped, otherwise false.
Default value is: false.
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

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.
  • 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:

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

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