org.jboss.as.plugin.deployment
Class Undeploy

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.jboss.as.plugin.common.AbstractServerMojo
          org.jboss.as.plugin.deployment.Undeploy

All Implemented Interfaces:

Closeable, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, ConnectionInfo

@Mojo(name="undeploy",
      threadSafe=true)
public class Undeploy
extends AbstractServerMojo

Undeploys the application to the JBoss Application Server.

Author:

James R. Perkins

Field Summary

protected String	matchPattern Specifies the name match pattern for undeploying/replacing artifacts.
protected String	matchPatternStrategy Specifies the strategy in case more than one matching artifact is found.
protected String	name Specifies the name used for the deployment.
protected org.apache.maven.project.MavenProject	project

Fields inherited from class org.jboss.as.plugin.common.AbstractServerMojo

DEBUG_MESSAGE_NO_CREDS, DEBUG_MESSAGE_NO_ID, DEBUG_MESSAGE_NO_SERVER_SECTION, DEBUG_MESSAGE_NO_SETTINGS_FILE, DEBUG_MESSAGE_POM_HAS_CREDS, DEBUG_MESSAGE_SETTINGS_HAS_CREDS, DEBUG_MESSAGE_SETTINGS_HAS_ID

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Undeploy()

Method Summary

protected void	doExecute() Executes additional processing.
void	execute()
protected Deployment.Status	executeDeployment(org.jboss.as.controller.client.ModelControllerClient client, Deployment deployment)
protected File	file() The archive file.
protected String	getMatchPattern() Returns the matching pattern for undeploy and redeploy goals.
protected MatchPatternStrategy	getMatchPatternStrategy() Returns the matching pattern strategy to use if more than one deployment matches the pattern returns more than one instance of a deployment.
protected org.jboss.as.plugin.deployment.PackageType	getPackageType()
Deployment.Type	getType() The type of the deployment.
String	goal() The goal of the deployment.
protected void	validate() Validates the deployment.

Methods inherited from class org.jboss.as.plugin.common.AbstractServerMojo

close, getCallbackHandler, getClient, getHostAddress, getPort, hostname, isDomainServer, isSkip

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

matchPattern

@Parameter(alias="match-pattern")
protected String matchPattern

Specifies the name match pattern for undeploying/replacing artifacts.

matchPatternStrategy

@Parameter(alias="match-pattern-strategy")
protected String matchPatternStrategy

Specifies the strategy in case more than one matching artifact is found.

• first: The first artifact is taken for undeployment/replacement. Other artifacts won't be touched. The list of artifacts is sorted using the default collator.
• all: All matching artifacts are undeployed.
• fail: Deployment fails.

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

name

@Parameter
protected String 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>

Constructor Detail

Undeploy

public Undeploy()

Method Detail

getMatchPattern

protected String getMatchPattern()

Returns the matching pattern for undeploy and redeploy goals. By default null is returned.

Returns:

the pattern or null

getMatchPatternStrategy

protected MatchPatternStrategy getMatchPatternStrategy()

Returns the matching pattern strategy to use if more than one deployment matches the pattern returns more than one instance of a deployment. By default null is returned.

Returns:

the matching strategy or null

goal

public String goal()

The goal of the deployment.

Returns:

the goal of the deployment.

getType

public Deployment.Type getType()

The type of the deployment.

Returns:

the deployment type.

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException,
                         org.apache.maven.plugin.MojoFailureException

Executes additional processing.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

execute()

file

protected File file()

The archive file.

Returns:

the archive file.

getPackageType

protected final org.jboss.as.plugin.deployment.PackageType getPackageType()

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeDeployment

protected final Deployment.Status executeDeployment(org.jboss.as.controller.client.ModelControllerClient client,
                                                    Deployment deployment)
                                             throws DeploymentExecutionException,
                                                    DeploymentFailureException,
                                                    IOException

Throws:

DeploymentExecutionException

DeploymentFailureException

IOException

validate

protected void validate()
                 throws DeploymentFailureException

Validates the deployment.

Throws:

DeploymentFailureException - if the deployment is invalid.