org.mule.runtime.module.deployment.api

Interface DeploymentService

All Superinterfaces:

DeploymentListenerManager, DomainBundleDeploymentListenerManager, DomainDeploymentListenerManager

All Known Implementing Classes:

MuleDeploymentService

@NoImplement
public interface DeploymentService
extends DeploymentListenerManager, DomainDeploymentListenerManager, DomainBundleDeploymentListenerManager

Manages deploy of mule applications

Method Summary

Modifier and Type	Method and Description
void	addStartupListener(StartupListener listener)
void	deploy(URI appArchiveUri) Deploys an application bundled as a zip from the given URL to the mule container
void	deploy(URI appArchiveUri, Properties appProperties) Deploys an application bundled as a zip from the given URL to the mule container and applies the provided properties.
void	deployDomain(URI domainArchiveUri) Deploys a domain artifact from the given URL to the mule container
void	deployDomain(URI domainArchiveUri, Properties deploymentProperties) Deploys a domain bundled as a zip from the given URL to the mule container
void	deployDomainBundle(URI domainArchiveUri) Deploys a domain bundle from the given URL to the mule container
Application	findApplication(String appName) Finds an active application by name.
Domain	findDomain(String domainName) .
Collection<Application>	findDomainApplications(String domain)
List<Application>	getApplications() Lists all applications that are deployed, starting or failed to start
List<Domain>	getDomains()
ReentrantLock	getLock() Obtains the object used to synchronize the service.
void	redeploy(String artifactName) Undeploys and redeploys an application
void	redeploy(String artifactName, Properties appProperties) Undeploys and redeploys an application including the provided appProperties.
void	redeploy(URI archiveUri) Undeploys and redeploys an application using a new artifact URI.
void	redeploy(URI archiveUri, Properties appProperties) Undeploys and redeploys an application using a new artifact URI and including the provided appProperties.
void	redeployDomain(String domainName) Undeploys and redeploys a domain
void	redeployDomain(String domainName, Properties deploymentProperties) Undeploys and redeploys a domain
void	removeStartupListener(StartupListener listener)
void	start()
void	stop()
void	undeploy(String appName) Undeploys an application from the mule container
void	undeployDomain(String domainName) Undeploys a domain from the mule container

Methods inherited from interface org.mule.runtime.module.deployment.api.DeploymentListenerManager

addDeploymentListener, removeDeploymentListener

Methods inherited from interface org.mule.runtime.module.deployment.api.DomainDeploymentListenerManager

addDomainDeploymentListener, removeDomainDeploymentListener

Methods inherited from interface org.mule.runtime.module.deployment.api.DomainBundleDeploymentListenerManager

addDomainBundleDeploymentListener, removeDomainBundleDeploymentListener

Method Detail

findApplication

Application findApplication(String appName)

Finds an active application by name.

Returns:

null if not found

getApplications

List<Application> getApplications()

Lists all applications that are deployed, starting or failed to start

Returns:

immutable applications list

findDomain

Domain findDomain(String domainName)

.

Parameters:

domainName - name of the domain

Returns:

the domain with the name domainName, null if there is no domain with domainName

findDomainApplications

Collection<Application> findDomainApplications(String domain)

Parameters:

domain - name of a deployed domain

Returns:

all the applications deployed in that domain

getDomains

List<Domain> getDomains()

Returns:

list of domains deployed in mule.

addStartupListener

void addStartupListener(StartupListener listener)

removeStartupListener

void removeStartupListener(StartupListener listener)

getLock

ReentrantLock getLock()

Obtains the object used to synchronize the service.

Returns:

a non null lock object.

undeploy

void undeploy(String appName)

Undeploys an application from the mule container

Parameters:

appName - name of the application to undeploy

deploy

void deploy(URI appArchiveUri)
     throws IOException

Deploys an application bundled as a zip from the given URL to the mule container

Parameters:

appArchiveUri - location of the zip application file

Throws:

IOException

deploy

void deploy(URI appArchiveUri,
            Properties appProperties)
     throws IOException

Deploys an application bundled as a zip from the given URL to the mule container and applies the provided properties.

Parameters:

appArchiveUri -

appProperties -

Throws:

IOException

redeploy

void redeploy(String artifactName)

Undeploys and redeploys an application

Parameters:

artifactName - then name of the application to redeploy

redeploy

void redeploy(String artifactName,
              Properties appProperties)

Undeploys and redeploys an application including the provided appProperties.

Parameters:

artifactName - then name of the application to redeploy

appProperties - map of properties to include

redeploy

void redeploy(URI archiveUri,
              Properties appProperties)
       throws IOException

Undeploys and redeploys an application using a new artifact URI and including the provided appProperties.

Parameters:

archiveUri - location of the application file

appProperties - map of properties to include

Throws:

IOException

redeploy

void redeploy(URI archiveUri)
       throws IOException

Undeploys and redeploys an application using a new artifact URI.

Parameters:

archiveUri - location of the application file

Throws:

IOException

undeployDomain

void undeployDomain(String domainName)

Undeploys a domain from the mule container

Parameters:

domainName - name of the domain to undeploy

deployDomain

void deployDomain(URI domainArchiveUri)
           throws IOException

Deploys a domain artifact from the given URL to the mule container

Parameters:

domainArchiveUri - location of the domain file

Throws:

IOException

deployDomain

void deployDomain(URI domainArchiveUri,
                  Properties deploymentProperties)
           throws IOException

Deploys a domain bundled as a zip from the given URL to the mule container

Parameters:

domainArchiveUri - location of the zip domain file.

deploymentProperties - the properties to override during the deployment process.

Throws:

IOException

redeployDomain

void redeployDomain(String domainName,
                    Properties deploymentProperties)

Undeploys and redeploys a domain

Parameters:

domainName - then name of the domain to redeploy.

deploymentProperties - the properties to override during the deployment process.

redeployDomain

void redeployDomain(String domainName)

Undeploys and redeploys a domain

Parameters:

domainName - then name of the domain to redeploy

deployDomainBundle

void deployDomainBundle(URI domainArchiveUri)
                 throws IOException

Deploys a domain bundle from the given URL to the mule container

Parameters:

domainArchiveUri - location of the ZIP domain file

Throws:

IOException - if there is any problem reading the file

start

void start()

stop

void stop()