AbstractMuleMojo (Mule Maven Plugin 2.2.1 API)

java.lang.Object
- AbstractMojo
- - org.mule.tools.maven.plugin.mule.AbstractMuleMojo

Direct Known Subclasses:: DeployMojo, UndeployMojo

public abstract class AbstractMuleMojo
extends AbstractMojo

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractMuleMojo.DeploymentType

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 ArtifactFactory`	`artifactFactory`
`protected ArtifactResolver`	`artifactResolver`
`protected String`	`businessGroup` Business group for deployment, if it is a nested one its format should be first.second.
`protected SettingsDecrypter`	`decrypter`
`protected AbstractMuleMojo.DeploymentType`	`deploymentType` Deployment information.
`protected File`	`domain`
`protected String`	`environment` Anypoint environment name.
`protected ArtifactRepository`	`localRepository`
`protected 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 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.

Constructor Summary

Constructors
Constructor and Description

AbstractMuleMojo()

Constructors
Constructor and Description
`AbstractMuleMojo()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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 Artifact`	`resolveMavenProjectArtifact()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - settings
```
protected Settings settings
```
  - decrypter
```
protected SettingsDecrypter decrypter
```
  - mavenProject
```
protected MavenProject mavenProject
```
  - artifactFactory
```
protected ArtifactFactory artifactFactory
```
  - artifactResolver
```
protected ArtifactResolver artifactResolver
```
  - localRepository
```
protected ArtifactRepository localRepository
```
  - skip
```
protected String skip
```
  - domain
```
protected File domain
```
  - script
```
protected File script
```
  - timeout
```
protected int timeout
```
  - 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
```
protected String username
```
    Anypoint Platform username.
    
    Since:
    
    2.0
  - password
```
protected String password
```
    Anypoint Platform password.
    
    Since:
    
    2.0
  - deploymentType
```
protected AbstractMuleMojo.DeploymentType deploymentType
```
    Deployment information.
    
    Since:
    
    1.0
  - uri
```
protected String uri
```
    Anypoint Platform URI, can be configured to use with On Premise platform..
    
    Since:
    
    2.0
  - environment
```
protected String environment
```
    Anypoint environment name.
    
    Since:
    
    2.0
  - muleHome
```
protected File muleHome
```
    Path to a Mule Standalone server. This parameter and muleDistribution and muleVersion are mutual exclusive.
    
    Since:
    
    2.0
  - muleVersion
```
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
```
protected Integer size
```
    Number of cluster nodes.
    
    Since:
    
    1.0
  - businessGroup
```
protected String businessGroup
```
    Business group for deployment, if it is a nested one its format should be first.second.
    
    Since:
    
    2.1
  - armInsecure
```
protected boolean armInsecure
```
    Use insecure mode for ARM deployment: do not validate certificates, nor hostname.
    
    Since:
    
    2.1
  - application
```
protected File application
```
    Application file to be deployed.
    
    Since:
    
    1.0
  - 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
```
protected String target
```
    Anypoint Platform target name.
    
    Since:
    
    2.0
    
    See Also:
    
    targetType
  - targetType
```
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 MojoExecutionException,
                    MojoFailureException
```
    Throws:
    
    MojoExecutionException
    
    MojoFailureException
    
    See Also:
    
    org.apache.maven.plugin.Mojo#execute()
  - doExecute
```
protected abstract void doExecute()
                           throws MojoFailureException,
                                  MojoExecutionException
```
    Throws:
    
    MojoFailureException
    
    MojoExecutionException
  - getDependency
```
protected File getDependency(ArtifactDescription artifactDescription)
                      throws MojoExecutionException,
                             MojoFailureException
```
    Throws:
    
    MojoExecutionException
    
    MojoFailureException
  - addDomain
```
protected void addDomain(Deployer deployer)
                  throws MojoFailureException
```
    Throws:
    
    MojoFailureException
  - readFile
```
protected String readFile(String file)
                   throws IOException
```
    Throws:
    
    IOException
  - executeGroovyScript
```
protected void executeGroovyScript()
                            throws MojoExecutionException
```
    Throws:
    
    MojoExecutionException
  - addDependencies
```
protected void addDependencies(Deployer deployer)
                        throws MojoFailureException,
                               MojoExecutionException
```
    Throws:
    
    MojoFailureException
    
    MojoExecutionException
  - resolveMavenProjectArtifact
```
protected Artifact resolveMavenProjectArtifact()
                                        throws MojoFailureException
```
    Throws:
    
    MojoFailureException
  - initializeApplication
```
protected void initializeApplication()
                              throws MojoFailureException
```
    Throws:
    
    MojoFailureException
  - initializeEnvironment
```
protected void initializeEnvironment()
                              throws MojoExecutionException
```
    Throws:
    
    MojoExecutionException

Class AbstractMuleMojo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

settings

decrypter

mavenProject

artifactFactory

artifactResolver

localRepository

skip

domain

script

timeout

server

username

password

deploymentType

uri

environment

muleHome

muleVersion

size

businessGroup

armInsecure

application

applicationName

target

targetType

Constructor Detail

AbstractMuleMojo

Method Detail

execute

doExecute

getDependency

addDomain

readFile

executeGroovyScript

addDependencies

resolveMavenProjectArtifact

initializeApplication

initializeEnvironment