org.wildfly.plugin.deployment

Class DeployMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.wildfly.plugin.common.AbstractServerConnection

org.wildfly.plugin.deployment.DeployMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

RunMojo

@Mojo(name="deploy",
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
@Execute(phase=PACKAGE)
public class DeployMojo
extends AbstractServerConnection

Deploys the application to the WildFly Application Server.

If force is set to true, the server is queried to see if the application already exists. If the application already exists, the application is redeployed instead of deployed. If the application does not exist the application is deployed as normal.

If force is set to false and the application has already been deployed to the server, an error will occur and the deployment will fail.

Author:

James R. Perkins

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name Specifies the name used for the deployment.
protected org.apache.maven.project.MavenProject	project
protected String	runtimeName The runtime name for the dployment.

Fields inherited from class org.wildfly.plugin.common.AbstractServerConnection

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

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, Path wildflyHome)
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.
protected void	validate(org.jboss.as.controller.client.ModelControllerClient client, boolean isDomain) Validates the deployment.

Methods inherited from class org.wildfly.plugin.common.AbstractServerConnection

createClient, getClientConfiguration

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

name

@Parameter
protected String name

Specifies the name used for the deployment.

runtimeName

@Parameter(alias="runtime-name",
           property="wildfly.deployment.runtime.name")
protected String runtimeName

The runtime name for the dployment.

In some cases users may wish to have two deployments with the same runtime-name (e.g. two versions of example.war) both available in the management configuration, in which case the deployments would need to have distinct name values but would have the same runtime-name.

Constructor Detail

DeployMojo

public DeployMojo()

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.

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,
                                  Path wildflyHome)
                                             throws DeploymentExecutionException,
                                                    DeploymentFailureException,
                                                    IOException

Throws:

DeploymentExecutionException

DeploymentFailureException

IOException

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

validate

protected void validate(org.jboss.as.controller.client.ModelControllerClient client,
            boolean isDomain)
                 throws DeploymentFailureException

Validates the deployment.

Parameters:

client - the client used for validation

isDomain - true if this is a domain server, otherwise false

Throws:

DeploymentFailureException - if the deployment is invalid.