org.jboss.as.plugin.deployment
Class UndeployArtifact

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

All Implemented Interfaces:

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

@Mojo(name="undeploy-artifact",
      threadSafe=true)
public final class UndeployArtifact
extends AbstractServerMojo

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

Author:

James R. Perkins

Field Summary

protected String

name Specifies the name used for the deployment.

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

UndeployArtifact()

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.
Deployment.Type	getType() The type of the deployment.
String	goal() The goal of the deployment.
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

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

UndeployArtifact

public UndeployArtifact()

Method Detail

validate

public void validate()
              throws DeploymentFailureException

Validates the deployment.

Throws:

DeploymentFailureException - if the deployment is invalid.

file

protected File file()

The archive file.

Returns:

the archive file.

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.

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

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()

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