Package org.craftercms.deployer.api

Interface DeploymentService

All Known Implementing Classes:

DeploymentServiceImpl

public interface DeploymentService

Service for doing deployments.

Author:

avasquez

Method Summary

Modifier and Type	Method	Description
List<Deployment>	deployAllTargets(boolean waitTillDone, Map<String,Object> params)	Deploys all targets
Deployment	deployTarget(String env, String siteName, boolean waitTillDone, Map<String,Object> params)	Deploys a single target

Method Detail

deployAllTargets

List<Deployment> deployAllTargets(boolean waitTillDone,
                                  Map<String,Object> params)
                           throws DeploymentServiceException

Deploys all targets

Parameters:

waitTillDone - if the method should wait till all deployments are done or return immediately

params - additional parameters that can be used by the deployment processors

Returns:

the list of deployment info for each target

Throws:

DeploymentServiceException - if there was an error while executing the deployments

deployTarget

Deployment deployTarget(String env,
                        String siteName,
                        boolean waitTillDone,
                        Map<String,Object> params)
                 throws TargetNotFoundException,
                        DeploymentServiceException

Deploys a single target

Parameters:

env - the target's environment (e.g. dev)

siteName - the target's site name (e.g. mysite)

waitTillDone - if the method should wait till the deployment is done or return immediately

params - additional parameters that can be used by the deployment processors

Returns:

the deployment info

Throws:

DeploymentServiceException - if there was an error while executing the deployments

TargetNotFoundException