org.jboss.as.plugin.deployment

Class Undeploy

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jboss.as.plugin.common.AbstractServerConnection

org.jboss.as.plugin.deployment.Undeploy

All Implemented Interfaces:

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

@Mojo(name="undeploy",
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class Undeploy
extends AbstractServerConnection

Undeploys the application to the JBoss Application Server.

Author:

James R. Perkins

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.project.MavenProject	project

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

CLIENT_LOCK, 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

Constructors

Constructor and Description
Undeploy()

Method Summary

Methods

Modifier and Type	Method and Description
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 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.AbstractServerConnection

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

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

project

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

Constructor Detail

Undeploy

public Undeploy()

Method Detail

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.