Package com.xebialabs.xlrelease.domain
Class GateTask
- java.lang.Object
-
- com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
-
- com.xebialabs.xlrelease.domain.PlanItem
-
- com.xebialabs.xlrelease.domain.Task
-
- com.xebialabs.xlrelease.domain.GateTask
-
- All Implemented Interfaces:
ConfigurationItem
,Lockable
,VisitableItem
,java.io.Serializable
,java.lang.Comparable<BaseConfigurationItem>
@Metadata(label="Gate", versioned=false) public class GateTask extends Task
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.xebialabs.xlrelease.domain.Task
CATEGORY_INPUT, CATEGORY_OUTPUT, delayDuringBlackout, DUE_SOON_THRESHOLD, executionId, failureHandler, failuresCount, hasBeenDelayed, hasBeenFlagged, IS_AUTOMATED_AND_IN_PROGRESS, maxCommentSize, originalScheduledStartDate, postponedDueToBlackout, postponedUntilEnvironmentsAreReserved, precondition, status, tags, taskFailureHandlerEnabled, taskRecoverOp, team, UNKNOWN_TASK_TYPE, variableMapping, waitForScheduledStartDate
-
Fields inherited from class com.xebialabs.xlrelease.domain.PlanItem
BY_TITLE, description, dueDate, endDate, flagComment, flagStatus, overdueNotified, owner, plannedDuration, scheduledStartDate, startDate, title
-
Fields inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
id, syntheticProperties, type
-
Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem
SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD
-
-
Constructor Summary
Constructors Constructor Description GateTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCondition(GateCondition condition)
void
addDependency(Dependency dependency)
protected Changes
execute(java.lang.String targetId, TaskStartOrRetryOperation operation)
java.util.Set<java.lang.String>
freezeVariablesInCustomFields(java.util.Map<java.lang.String,ValueWithInterpolation> variables, java.util.Map<java.lang.String,java.lang.String> passwordVariables, Changes changes, boolean freezeEvenIfUnresolved)
To be overridden in child classes with custom fields that can contain variables.java.lang.String
getAbortedDependencyTitles()
GateCondition
getCondition(java.lang.String id)
java.util.List<GateCondition>
getConditions()
java.util.List<Dependency>
getDependencies()
java.util.List<UsagePoint>
getVariableUsages()
boolean
hasAbortedDependencies()
boolean
hasConditions()
boolean
hasDependencies()
boolean
isCompletable()
boolean
isOpen()
Changes
markAsDone(java.lang.String targetId, TaskStatus targetStatus)
void
setConditions(java.util.List<GateCondition> conditions)
void
setDependencies(java.util.List<Dependency> dependencies)
void
updateCondition(GateCondition gateCondition)
-
Methods inherited from class com.xebialabs.xlrelease.domain.Task
abort, accept, addWatcher, applyDefaults, canBeBackup, canScheduleTaskStart, canStartNow, checkDatesValidity, clearComments, delayDuringBlackoutHasChanged, deleteAttachment, deleteTask, fail, fail, fail, fail, failureHandlerHasChanged, findComment, freezeVariables, fromType, fromType, generateExecutionId, getAbortScript, getAllTasks, getAttachments, getChildren, getCiUid, getComments, getConfigurationUri, getContainer, getDelayedCount, getDisplayPath, getElapsedDurationFraction, getExecutionId, getFacets, getFailureHandler, getFailuresCount, getFlaggedCount, getInputVariables, getMaxCommentSize, getOriginalScheduledStartDate, getPhase, getPrecondition, getReferencedVariables, getRelease, getReleaseOwner, getReleaseUid, getStatus, getTags, getTaskRecoverOp, getTaskType, getTeam, getUnboundRequiredVariables, getUrl, getVariableMapping, getWatchers, hasAbortScript, hasBeenDelayed, hasBeenFlagged, hasBeenStarted, hasFailureHandlerScript, hasTaskRecoverOp, hasTeam, hasVariableMapping, isAborted, isAbortScriptInProgress, isActive, isAssignedTo, isAutomated, isCheckAttributes, isCompletedInAdvance, isDefaultTaskType, isDefunct, isDelayDuringBlackout, isDone, isDoneInAdvance, isDueSoon, isDueSoonNotified, isFacetInProgress, isFailed, isFailing, isFailureHandlerEnabled, isFailureHandlerInProgress, isGate, isInProgress, isLocked, isMovable, isNotYetReached, isParallelGroup, isPending, isPlanned, isPostponedDueToBlackout, isPostponedUntilEnvironmentsAreReserved, isPreconditionEnabled, isPreconditionInProgress, isSkipped, isSkippedInAdvance, isStillExecutingScript, isSupportedInWorkflow, isTaskFailureHandlerEnabled, isTaskGroup, isUpdatable, isWaitForScheduledStartDate, isWaitingForInput, lock, ownerHasBeenReassigned, postponeUntilEnvironmentsAreReserved, preconditionHasChanged, removeWatcher, reopen, replaceTask, resetToPlanned, retry, setAttachments, setCheckAttributes, setCiUid, setConfigurationUri, setContainer, setDelayDuringBlackout, setDueSoonNotified, setExecutionId, setFacets, setFailureHandler, setFailuresCount, setFlagStatus, setHasBeenDelayed, setHasBeenFlagged, setLocked, setMaxCommentSize, setOriginalScheduledStartDate, setPostponedDueToBlackout, setPostponedUntilEnvironmentsAreReserved, setPrecondition, setReleaseUid, setScheduledStartDate, setStatus, setSupportedInWorkflow, setTags, setTaskFailureHandlerEnabled, setTaskRecoverOp, setTeam, setVariableMapping, setWaitForScheduledStartDate, setWatchers, shouldFacetBeChecked, shouldFreezeVariableMapping, shouldNotifyDueSoon, shouldPreconditionBeChecked, start, startNow, startPending, startWithInput, teamHasBeenReassigned, unlock, updateComment
-
Methods inherited from class com.xebialabs.xlrelease.domain.PlanItem
calculateDueDate, checkDatesValidity, getActualDuration, getComputedPlannedDuration, getDescription, getDueDate, getEndDate, getEndOrDueDate, getFlagComment, getFlagStatus, getOrCalculateDueDate, getOwner, getPlannedDuration, getScheduledStartDate, getStartDate, getStartOrScheduledDate, getTitle, hasDueDate, hasEndDate, hasEndOrDueDate, hasOwner, hasOwner, hasPlannedDuration, hasScheduledStartDate, hasStartDate, hasStartOrScheduledDate, hasTitle, hasTitle, hasValidStartDates, isFlagged, isOverdue, isOverdueNotified, isTitleContaining, moveChildren, setDates, setDescription, setDueDate, setEndDate, setFlagComment, setOverdueNotified, setOwner, setPlannedDuration, setStartAndEndDatesIfEmpty, setStartDate, setTitle, shouldNotifyOverdue, updateDates, updateDuration
-
Methods inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
compareTo, equals, get$ciAttributes, get$directoryReference, get$externalProperties, get$internalId, get$referenceId, get$securedCi, get$securedDirectoryReference, get$token, get$validationMessages, getId, getName, getProperty, getPropertyDescriptor, getType, hashCode, hasProperty, set$ciAttributes, set$directoryReference, set$externalProperties, set$internalId, set$referenceId, set$securedCi, set$securedDirectoryReference, set$token, set$validationMessages, setId, setProperty, setType, toString
-
-
-
-
Method Detail
-
getConditions
public java.util.List<GateCondition> getConditions()
-
addCondition
public void addCondition(GateCondition condition)
-
getCondition
public GateCondition getCondition(java.lang.String id)
-
hasConditions
public boolean hasConditions()
-
setConditions
public void setConditions(java.util.List<GateCondition> conditions)
-
getDependencies
public java.util.List<Dependency> getDependencies()
-
setDependencies
public void setDependencies(java.util.List<Dependency> dependencies)
-
hasDependencies
public boolean hasDependencies()
-
addDependency
public void addDependency(Dependency dependency)
-
execute
protected Changes execute(java.lang.String targetId, TaskStartOrRetryOperation operation)
-
markAsDone
public Changes markAsDone(java.lang.String targetId, TaskStatus targetStatus)
- Overrides:
markAsDone
in classTask
- Parameters:
targetId
- since tasks nest, this can either be the id of this task or the id of one of its children
-
isOpen
public boolean isOpen()
-
isCompletable
public boolean isCompletable()
-
freezeVariablesInCustomFields
public java.util.Set<java.lang.String> freezeVariablesInCustomFields(java.util.Map<java.lang.String,ValueWithInterpolation> variables, java.util.Map<java.lang.String,java.lang.String> passwordVariables, Changes changes, boolean freezeEvenIfUnresolved)
Description copied from class:Task
To be overridden in child classes with custom fields that can contain variables.
ApplyVariableHelper.replaceAll(Object, Map, Set, boolean)
to each field; if child entities are modified, add them tochanges
.- Overrides:
freezeVariablesInCustomFields
in classTask
-
hasAbortedDependencies
public boolean hasAbortedDependencies()
-
getAbortedDependencyTitles
public java.lang.String getAbortedDependencyTitles()
-
updateCondition
public void updateCondition(GateCondition gateCondition)
-
getVariableUsages
public java.util.List<UsagePoint> getVariableUsages()
- Overrides:
getVariableUsages
in classTask
-
-