ICleanJobUnit

All Superinterfaces:: IJobUnit

public interface ICleanJobUnit extends IJobUnit

Typed IJobUnit. Cleans local deployment space and/or removes old builds of selected build artifacts. Either setLocalDeploymentSpaceName(String) or setMaxBuildAgeDays(int) must be set.

Version:: $Revision:57153 $ $Date:2006-08-08 13:12:26Z $
Author:: Stepan Roh, Polarion Software

Field Summary

Fields inherited from interface com.polarion.platform.jobs.IJobUnit
UNKNOWN_WORK_LENGTH
Method Summary

Modifier and Type

Method

Description

void

setBuildArtifacts(IBuildArtifactSelector... selectors)

Selectors of artifacts for which old builds should be removed.

void

setLocalDeploymentSpaceName(String localDeploymentSpaceName)

Name of local deployment space to clean.

void

setMaxBuildAgeDays(int days)

Builds of selected artifacts older then this count of days will be deleted.

void

setMinSuccessfulBuildsCount(int count)

When deleting old builds at least this count of successful builds will be preserved.

Methods inherited from interface com.polarion.platform.jobs.IJobUnit
activate, getCreator, getJob, getLogger, getName, getPriority, getScope, getWorkLength, run, setJob, setLogger, setScope, setWorkDir

Method Details
- setLocalDeploymentSpaceName
  
  void setLocalDeploymentSpaceName(String localDeploymentSpaceName)
  
  Name of local deployment space to clean.
  It is permitted to try to clean up missing deployment space.
  
  Parameters:
  
  localDeploymentSpaceName - name of local deployment space or null
  
  Throws:
  
  IllegalArgumentException - if localDeploymentSpaceName is null
- setMaxBuildAgeDays
  
  void setMaxBuildAgeDays(int days)
  
  Builds of selected artifacts older then this count of days will be deleted. If this parameter is not set, no builds are removed.
  Parameters:
  
  days -
  
  Since:
  
  3.4.0
  
  See Also:
  
  setMinSuccessfulBuildsCount(int)
- setBuildArtifacts
  
  void setBuildArtifacts(IBuildArtifactSelector... selectors)
  
  Selectors of artifacts for which old builds should be removed. This parameter is required if @{link setMaxBuildAgeDays(int) is set.
  
  Parameters:
  
  selectors -
  
  Since:
  
  3.4.0
- setMinSuccessfulBuildsCount
  
  void setMinSuccessfulBuildsCount(int count)
  
  When deleting old builds at least this count of successful builds will be preserved. This parameter is required if @{link setMaxBuildAgeDays(int) is set.
  
  Parameters:
  
  count -
  
  Since:
  
  3.4.0