org.mule.tools.maven.plugin.mule

Class AbstractMuleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.mule.tools.maven.plugin.mule.AbstractMuleMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DeployMojo, UndeployMojo

public abstract class AbstractMuleMojo
extends org.apache.maven.plugin.AbstractMojo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMuleMojo.DeploymentType

Field Summary

Fields

Modifier and Type	Field and Description
protected File	application Application file to be deployed.
protected String	applicationName Name of the application to deploy/undeploy.
protected boolean	armInsecure Use insecure mode for ARM deployment: do not validate certificates, nor hostname.
protected org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
protected String	businessGroup Business group for deployment, if it is a nested one its format should be first.second.
protected org.apache.maven.settings.crypto.SettingsDecrypter	decrypter
protected AbstractMuleMojo.DeploymentType	deploymentType Deployment information.
protected File	domain
protected String	environment Anypoint environment name.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository
protected org.apache.maven.project.MavenProject	mavenProject
protected File	muleHome Path to a Mule Standalone server.
protected String	muleVersion Version of the Mule Runtime Enterprise distribution to download.
protected String	password Anypoint Platform password.
protected File	script
protected String	server Maven server with Anypoint Platform credentials.
protected org.apache.maven.settings.Settings	settings
protected Integer	size Number of cluster nodes.
protected String	skip
protected String	target Anypoint Platform target name.
protected TargetType	targetType Anypoint Platform target type: server, serverGroup or cluster.
protected int	timeout
protected String	uri Anypoint Platform URI, can be configured to use with On Premise platform..
protected String	username Anypoint Platform username.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractMuleMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addDependencies(Deployer deployer)
protected void	addDomain(Deployer deployer)
protected abstract void	doExecute()
void	execute()
protected void	executeGroovyScript()
protected File	getDependency(ArtifactDescription artifactDescription)
protected void	initializeApplication()
protected void	initializeEnvironment()
protected String	readFile(String file)
protected org.apache.maven.artifact.Artifact	resolveMavenProjectArtifact()

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

settings

@Component
protected org.apache.maven.settings.Settings settings

decrypter

@Component
protected org.apache.maven.settings.crypto.SettingsDecrypter decrypter

mavenProject

@Component
protected org.apache.maven.project.MavenProject mavenProject

artifactFactory

@Component
protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

localRepository

@Parameter(defaultValue="${localRepository}",
           readonly=true)
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

skip

@Parameter(property="mule.skip")
protected String skip

domain

@Parameter
protected File domain

script

@Parameter(property="script",
           required=false)
protected File script

timeout

@Parameter(property="mule.timeout",
           required=false)
protected int timeout

server

@Parameter(required=false,
           property="maven.server")
protected String server

Maven server with Anypoint Platform credentials. This is only needed if you want to use your credentials stored in your Maven settings.xml file. This is NOT your Mule server name.

Since:

2.2

username

@Parameter(required=false,
           property="anypoint.username")
protected String username

Anypoint Platform username.

Since:

2.0

password

@Parameter(required=false,
           property="anypoint.password")
protected String password

Anypoint Platform password.

Since:

2.0

deploymentType

@Parameter(required=true)
protected AbstractMuleMojo.DeploymentType deploymentType

Deployment information.

Since:

1.0

uri

@Parameter(readonly=true,
           property="anypoint.uri",
           defaultValue="https://anypoint.mulesoft.com")
protected String uri

Anypoint Platform URI, can be configured to use with On Premise platform..

Since:

2.0

environment

@Parameter(required=false,
           property="anypoint.environment")
protected String environment

Anypoint environment name.

Since:

2.0

muleHome

@Parameter(property="mule.home")
protected File muleHome

Path to a Mule Standalone server. This parameter and muleDistribution and muleVersion are mutual exclusive.

Since:

2.0

muleVersion

@Parameter(property="mule.version")
protected String muleVersion

Version of the Mule Runtime Enterprise distribution to download. If you need to use Community version use muleDistribution parameter. This parameter and muleDistribution are mutual exclusive.

Since:

1.0

size

@Parameter(defaultValue="2",
           required=true)
protected Integer size

Number of cluster nodes.

Since:

1.0

businessGroup

@Parameter(defaultValue="",
           property="anypoint.businessGroup")
protected String businessGroup

Business group for deployment, if it is a nested one its format should be first.second.

Since:

2.1

armInsecure

@Parameter(defaultValue="Medium",
           readonly=true,
           property="arm.insecure")
protected boolean armInsecure

Use insecure mode for ARM deployment: do not validate certificates, nor hostname.

Since:

2.1

application

@Parameter(property="mule.application")
protected File application

Application file to be deployed.

Since:

1.0

applicationName

@Parameter(readonly=true,
           property="applicationName")
protected String applicationName

Name of the application to deploy/undeploy. If not specified, the artifact id will be used as the name. This parameter allows to override this behavior to specify a custom name.

Since:

2.0

target

@Parameter(property="anypoint.target")
protected String target

Anypoint Platform target name.

Since:

2.0

See Also:

targetType

targetType

@Parameter(property="anypoint.target.type")
protected TargetType targetType

Anypoint Platform target type: server, serverGroup or cluster.

Since:

2.0

Constructor Detail

AbstractMuleMojo

public AbstractMuleMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

doExecute

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

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getDependency

protected File getDependency(ArtifactDescription artifactDescription)
                      throws org.apache.maven.plugin.MojoExecutionException,
                             org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

addDomain

protected void addDomain(Deployer deployer)
                  throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

readFile

protected String readFile(String file)
                   throws IOException

Throws:

IOException

executeGroovyScript

protected void executeGroovyScript()
                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addDependencies

protected void addDependencies(Deployer deployer)
                        throws org.apache.maven.plugin.MojoFailureException,
                               org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

resolveMavenProjectArtifact

protected org.apache.maven.artifact.Artifact resolveMavenProjectArtifact()
                                                                  throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

initializeApplication

protected void initializeApplication()
                              throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

initializeEnvironment

protected void initializeEnvironment()
                              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException