org.mule.tools.maven.mojo.model

Class DeploymentConfiguration

java.lang.Object

org.mule.tools.maven.mojo.model.DeploymentConfiguration

public class DeploymentConfiguration
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected File	application
protected String	applicationName
protected String[]	arguments
protected boolean	armInsecure
protected List<ArtifactDescription>	artifactItems
protected String	businessGroup
protected boolean	community
protected Long	deploymentTimeout
protected AbstractMuleDeployerMojo.DeploymentType	deploymentType
protected File	domain
protected String	environment
protected boolean	failIfNotExists
protected List<File>	libs
protected ArtifactDescription	muleDistribution
protected File	muleHome
protected String	muleVersion
protected String	password
protected Map<String,String>	properties
protected String	region
protected File	script
protected String	server
protected Integer	size
protected String	skip
protected String	target
protected TargetType	targetType
protected int	timeout
protected String	uri
protected String	username
protected Integer	workers
protected String	workerType

Constructor Summary

Constructors

Constructor and Description
DeploymentConfiguration()

Method Summary

Modifier and Type	Method and Description
File	getApplication() Application file to be deployed.
String	getApplicationName() Name of the application to deploy/undeploy.
String[]	getArguments() List of Mule Runtime Standalone command line arguments.
List<ArtifactDescription>	getArtifactItems()
String	getBusinessGroup() Business group for deploymentConfiguration, if it is a nested one its format should be first.second.
Long	getDeploymentTimeout() DeploymentConfiguration timeout in milliseconds.
AbstractMuleDeployerMojo.DeploymentType	getDeploymentType() DeploymentConfiguration information.
File	getDomain()
String	getEnvironment() Anypoint environment name.
List<File>	getLibs() List of external libs (Jar files) to be added to MULE_HOME/user/lib directory.
ArtifactDescription	getMuleDistribution() Deprecated. Use the official maven artifact descriptor, if you need to use Community distribution @see community property
File	getMuleHome() Path to a Mule Standalone server.
String	getMuleVersion() Version of the Mule Runtime Enterprise distribution to download.
String	getPassword() Anypoint Platform password.
Map<String,String>	getProperties() CloudHub properties.
String	getRegion() Region to deploy the application in Cloudhub.
File	getScript()
String	getServer() Maven server with Anypoint Platform credentials.
Integer	getSize() Number of cluster nodes.
String	getSkip()
String	getTarget() Anypoint Platform target name.
TargetType	getTargetType() Anypoint Platform target type: server, serverGroup or cluster.
int	getTimeout()
String	getUri() Anypoint Platform URI, can be configured to use with On Premise platform..
String	getUsername() Anypoint Platform username.
Integer	getWorkers() Number of workers for the deploymentConfiguration of the application in Cloudhub.
String	getWorkerType() Type of workers for the deploymentConfiguration of the application in Cloudhub.
boolean	isArmInsecure() Use insecure mode for ARM deploymentConfiguration: do not validate certificates, nor hostname.
boolean	isCommunity() When set to true the plugin will use Mule Standalone Community Edition.
boolean	isFailIfNotExists() When set to false, undeployment won't fail if the specified application does not exist.
void	setApplication(File application)
void	setApplicationName(String applicationName)
void	setArguments(String[] arguments)
void	setArmInsecure(boolean armInsecure)
void	setArtifactItems(List<ArtifactDescription> artifactItems)
void	setBusinessGroup(String businessGroup)
void	setCommunity(boolean community)
void	setDeploymentTimeout(Long deploymentTimeout)
void	setDeploymentType(AbstractMuleDeployerMojo.DeploymentType deploymentType)
void	setDomain(File domain)
void	setEnvironment(String environment)
void	setFailIfNotExists(boolean failIfNotExists)
void	setLibs(List<File> libs)
void	setMuleDistribution(ArtifactDescription muleDistribution)
void	setMuleHome(File muleHome)
void	setMuleVersion(String muleVersion)
void	setPassword(String password)
void	setProperties(Map<String,String> properties)
void	setRegion(String region)
void	setScript(File script)
void	setServer(String server)
void	setSize(Integer size)
void	setSkip(String skip)
void	setTarget(String target)
void	setTargetType(TargetType targetType)
void	setTimeout(int timeout)
void	setUri(String uri)
void	setUsername(String username)
void	setWorkers(Integer workers)
void	setWorkerType(String workerType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

server

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

username

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

password

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

deploymentType

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

uri

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

environment

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

muleHome

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

muleVersion

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

size

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

businessGroup

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

armInsecure

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

application

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

applicationName

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

target

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

targetType

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

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

artifactItems

@Parameter
protected List<ArtifactDescription> artifactItems

community

@Parameter(readonly=true,
           required=false,
           defaultValue="false",
           property="mule.community")
protected boolean community

muleDistribution

@Parameter(readonly=true)
protected ArtifactDescription muleDistribution

deploymentTimeout

@Parameter(property="mule.deploymentConfiguration.timeout",
           defaultValue="60000",
           required=true)
protected Long deploymentTimeout

arguments

@Parameter(property="mule.arguments",
           required=false)
protected String[] arguments

libs

@Parameter
protected List<File> libs

region

@Parameter(property="cloudhub.region",
           defaultValue="us-east-1")
protected String region

workers

@Parameter(property="cloudhub.workers")
protected Integer workers

workerType

@Parameter(defaultValue="Medium",
           property="cloudhub.workerType")
protected String workerType

properties

@Parameter(required=false)
protected Map<String,String> properties

failIfNotExists

@Parameter(defaultValue="true")
protected boolean failIfNotExists

Constructor Detail

DeploymentConfiguration

public DeploymentConfiguration()

Method Detail

getServer

public String getServer()

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

setServer

public void setServer(String server)

getUsername

public String getUsername()

Anypoint Platform username.

Since:

2.0

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

Anypoint Platform password.

Since:

2.0

setPassword

public void setPassword(String password)

getDeploymentType

public AbstractMuleDeployerMojo.DeploymentType getDeploymentType()

DeploymentConfiguration information.

Since:

1.0

setDeploymentType

public void setDeploymentType(AbstractMuleDeployerMojo.DeploymentType deploymentType)

getUri

public String getUri()

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

Since:

2.0

setUri

public void setUri(String uri)

getEnvironment

public String getEnvironment()

Anypoint environment name.

Since:

2.0

setEnvironment

public void setEnvironment(String environment)

getMuleHome

public File getMuleHome()

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

Since:

2.0

setMuleHome

public void setMuleHome(File muleHome)

getMuleVersion

public String getMuleVersion()

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

setMuleVersion

public void setMuleVersion(String muleVersion)

getSize

public Integer getSize()

Number of cluster nodes.

Since:

1.0

setSize

public void setSize(Integer size)

getBusinessGroup

public String getBusinessGroup()

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

Since:

2.1

setBusinessGroup

public void setBusinessGroup(String businessGroup)

isArmInsecure

public boolean isArmInsecure()

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

Since:

2.1

setArmInsecure

public void setArmInsecure(boolean armInsecure)

getApplication

public File getApplication()

Application file to be deployed.

Since:

1.0

setApplication

public void setApplication(File application)

getApplicationName

public String getApplicationName()

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

setApplicationName

public void setApplicationName(String applicationName)

getTarget

public String getTarget()

Anypoint Platform target name.

Since:

2.0

See Also:

DeployMojo#targetType

setTarget

public void setTarget(String target)

getTargetType

public TargetType getTargetType()

Anypoint Platform target type: server, serverGroup or cluster.

Since:

2.0

setTargetType

public void setTargetType(TargetType targetType)

getSkip

public String getSkip()

setSkip

public void setSkip(String skip)

getDomain

public File getDomain()

setDomain

public void setDomain(File domain)

getScript

public File getScript()

setScript

public void setScript(File script)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

getArtifactItems

public List<ArtifactDescription> getArtifactItems()

setArtifactItems

public void setArtifactItems(List<ArtifactDescription> artifactItems)

isCommunity

public boolean isCommunity()

When set to true the plugin will use Mule Standalone Community Edition.

Since:

2.0

setCommunity

public void setCommunity(boolean community)

getMuleDistribution

public ArtifactDescription getMuleDistribution()

Deprecated. Use the official maven artifact descriptor, if you need to use Community distribution @see community property

Maven coordinates for the Mule Runtime distribution to download. You need to specify:

groupId artifactId version This parameter and muleVersion are mutual exclusive

Since:

1.0

setMuleDistribution

public void setMuleDistribution(ArtifactDescription muleDistribution)

getDeploymentTimeout

public Long getDeploymentTimeout()

DeploymentConfiguration timeout in milliseconds.

Since:

1.0

setDeploymentTimeout

public void setDeploymentTimeout(Long deploymentTimeout)

getArguments

public String[] getArguments()

List of Mule Runtime Standalone command line arguments. Adding a property to this list is the same that adding it to the command line when starting Mule using bin/mule. If you want to add a Mule property don't forget to prepend -M-D. If you want to add a System property for the Wrapper don't forget to prepend -D.

Example: <arguments><argument>-M-Djdbc.url=jdbc:oracle:thin:@myhost:1521:orcl</argument></arguments>

Since:

1.0

setArguments

public void setArguments(String[] arguments)

getLibs

public List<File> getLibs()

List of external libs (Jar files) to be added to MULE_HOME/user/lib directory.

Since:

1.0

setLibs

public void setLibs(List<File> libs)

getRegion

public String getRegion()

Region to deploy the application in Cloudhub.

Since:

2.0

setRegion

public void setRegion(String region)

getWorkers

public Integer getWorkers()

Number of workers for the deploymentConfiguration of the application in Cloudhub.

Since:

2.0

setWorkers

public void setWorkers(Integer workers)

getWorkerType

public String getWorkerType()

Type of workers for the deploymentConfiguration of the application in Cloudhub.

Since:

2.0

setWorkerType

public void setWorkerType(String workerType)

getProperties

public Map<String,String> getProperties()

CloudHub properties.

Since:

2.0

setProperties

public void setProperties(Map<String,String> properties)

isFailIfNotExists

public boolean isFailIfNotExists()

When set to false, undeployment won't fail if the specified application does not exist.

Since:

2.2

setFailIfNotExists

public void setFailIfNotExists(boolean failIfNotExists)