As described earlier, implementations of the atg.deployment.DeploymentManager class are used to initiate a DAF deployment and manage the deployment process. The following API is available:
public String deploy(DeploymentData[] pDataArray, DeploymentOptions pOptions)public String deploy(DeploymentData[] pDataArray, DeploymentOptions pOptions, java.lang.String pUserSpecifiedDeploymentId)public String deploy(DeploymentData pDeploymentData, DeploymentOptions pOptions)public String deploy(DeploymentData pDeploymentData, DeploymentOptions pOptions, java.lang.String pUserSpecifiedDeploymentId)public void cancel(java.lang.String pDeploymentId, boolean pAllowResume)public void resume(java.lang.String pDeploymentId)public void restart(java.lang.String pDeploymentId)public boolean isDeploymentRunning(java.lang.String pDeploymentId)public boolean deploymentExists(java.lang.String pDeploymentId)public DeploymentProgress getDeploymentProgress(java.lang.String pDeploymentId)public atg.deployment.DeploymentReporter getDeploymentReporter()public void purgeDeploymentData(java.lang.String pDeploymentId, boolean pPurgeDeploymentItem)
deploy
public String deploy(DeploymentData[] pDataArray, DeploymentOptions pOptions)
public String deploy(DeploymentData[] pDataArray, DeploymentOptions pOptions, java.lang.String pUserSpecifiedDeploymentId)
public String deploy(DeploymentData pDeploymentData, DeploymentOptions pOptions)
public String deploy(DeploymentData pDeploymentData, DeploymentOptions pOptions, java.lang.String pUserSpecifiedDeploymentId)
Use to start a new deployment. Specify the data to deploy in the pDataArray parameter. You can pass any number of DeploymentData objects into a single deploy() call.
Parameters:
pDataArray-- an array ofDeploymentDataobjectspDeploymentData – a single DeploymentData objectpOptions-- deployment-specific options used to control various aspects of the deploymentpUserSpecifiedDeploymentId –an optional user-specified deployment ID
Returns a deployment ID.
cancel
public void cancel(String pDeploymentId, boolean pAllowResume)
Use to cancel a running deployment.
Parameters:
pDeploymentId-- the deployment ID of the deployment to cancel.pAllowResume-- if set to true, deployment data is not purged, which allows the deployment to be resumed later. If set to false, deployment data is purged and the deployment ID is no longer valid.
resume
public void resume(String pDeploymentId)
Use to resume a deployment that failed or was cancelled.
Parameters:
pDeploymentId-- the deployment ID of the deployment to resume.
restart
public void restart(String pDeploymentId)
Use to restart (from the beginning) a deployment that failed or was cancelled.
Parameter: pDeploymentId -- the deployment ID of the deployment to restart.
isDeploymentRunning
public boolean isDeploymentRunning(java.lang.String pDeploymentId)
Use to determine if a given deployment is running. Returns true if the ID of the current deployment matches the value of pDeploymentId. Note: Returns false if the specified deployment is queued but not running.
deploymentExists
public boolean deploymentExists(java.lang.String pDeploymentId)
Use to determine if a deployment with the given ID exists in the deployment repository. Returns true if the deployment exists; returns false otherwise.
getDeploymentProgress
public DeploymentProgress getDeploymentProgress(java.lang.String pDeploymentId)
Returns a DeploymentProgress object, which contains information about the number of items that have been deployed and the total number of items in the deployment. See atg.deployment.DeploymentProgress for more information.
Parameters:
pDeploymentId-- the ID of the deployment for which you want progress information.
getDeploymentReporter
public atg.deployment.DeploymentReporter getDeploymentReporter()
Returns a DeploymentReporter object, which contains information about specific items that have been successfully deployed or have failed deployment. See atg.deployment.DeploymentReporter.
purgeDeploymentData
public void purgeDeploymentData(java.lang.String pDeploymentId, boolean pPurgeDeploymentItem)
Parameters:
pDeploymentId-- the ID of the deployment for which you want to purge the data.pPurgeDeploymentItem– indicate whether or not to purge the top-level deployment item from theDeploymentRepository
Removes the DeploymentData and Markers from the DeploymentRepository for the deployment with the given ID.
