Package com.xebialabs.xlrelease.domain
Class Task
- java.lang.Object
-
- com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
-
- com.xebialabs.xlrelease.domain.PlanItem
-
- com.xebialabs.xlrelease.domain.Task
-
- All Implemented Interfaces:
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem,Lockable,VisitableItem,java.io.Serializable,java.lang.Comparable<com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem>
- Direct Known Subclasses:
BaseScriptTask,ContainerTask,CreateReleaseTask,GateTask,NotificationTask,TaskGroup,UserInputTask
@Metadata(label="Manual", versioned=false) public class Task extends PlanItem implements LockableAn Digital.ai Release task. See alsoGateTask.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringCATEGORY_INPUTstatic java.lang.StringCATEGORY_OUTPUTstatic doubleDUE_SOON_THRESHOLDstatic java.util.function.Predicate<Task>IS_AUTOMATED_AND_IN_PROGRESSstatic com.xebialabs.deployit.plugin.api.reflect.TypeUNKNOWN_TASK_TYPE
-
Constructor Summary
Constructors Constructor Description Task()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Changesabort()voidaccept(ReleaseVisitor visitor)voidaddWatcher(java.lang.String watcher)booleancanBeBackup()booleancanScheduleTaskStart()booleancanStartNow()voidcheckDatesValidity()voidclearComments()booleandelayDuringBlackoutHasChanged(Task task)voiddeleteAttachment(java.lang.String attachmentId)voiddeleteTask(Task task)Changesfail(java.lang.String targetId, java.lang.String failReason)Changesfail(java.lang.String targetId, java.lang.String failReason, boolean fromAbort)Changesfail(java.lang.String targetId, java.lang.String failReason, com.xebialabs.xlrelease.user.User user)Changesfail(java.lang.String targetId, java.lang.String failReason, com.xebialabs.xlrelease.user.User user, boolean fromAbort)booleanfailureHandlerHasChanged(Task task)CommentfindComment(java.lang.String commentId)java.util.Set<java.lang.String>freezeVariables(Changes changes, boolean freezeEvenIfUnresolved)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.static <T extends Task>
TfromType(com.xebialabs.deployit.plugin.api.reflect.Type taskType)static <T extends Task>
TfromType(java.lang.String taskType)voidgenerateExecutionId()java.lang.StringgetAbortScript()java.util.List<Task>getAllTasks()java.util.List<Attachment>getAttachments()java.util.List<PlanItem>getChildren()java.lang.IntegergetCiUid()java.util.List<Comment>getComments()java.lang.StringgetConfigurationUri()TaskContainergetContainer()intgetDelayedCount()java.lang.StringgetDisplayPath()doublegetElapsedDurationFraction()java.lang.StringgetExecutionId()java.util.List<Facet>getFacets()java.lang.StringgetFailureHandler()intgetFailuresCount()intgetFlaggedCount()java.util.List<Variable>getInputVariables()intgetMaxCommentSize()java.util.DategetOriginalScheduledStartDate()PhasegetPhase()java.lang.StringgetPrecondition()java.util.List<Variable>getReferencedVariables()ReleasegetRelease()java.lang.StringgetReleaseOwner()java.lang.IntegergetReleaseUid()TaskStatusgetStatus()java.util.List<java.lang.String>getTags()TaskRecoverOpgetTaskRecoverOp()com.xebialabs.deployit.plugin.api.reflect.TypegetTaskType()java.lang.StringgetTeam()java.lang.StringgetUrl()java.util.Map<java.lang.String,java.lang.String>getVariableMapping()java.util.List<UsagePoint>getVariableUsages()java.util.Set<java.lang.String>getWatchers()booleanhasAbortScript()booleanhasBeenDelayed()booleanhasBeenFlagged()booleanhasBeenStarted()booleanhasTeam()booleanhasVariableMapping()booleanisAborted()booleanisAbortScriptInProgress()booleanisActive()booleanisAssignedTo(Team team)booleanisAutomated()booleanisCheckAttributes()booleanisCompletedInAdvance()static booleanisDefaultTaskType(com.xebialabs.deployit.plugin.api.reflect.Type type)booleanisDefunct()booleanisDelayDuringBlackout()booleanisDone()booleanisDoneInAdvance()booleanisDueSoon()booleanisDueSoonNotified()booleanisFacetInProgress()booleanisFailed()booleanisFailing()booleanisFailureHandlerEnabled()booleanisFailureHandlerInProgress()booleanisGate()booleanisInProgress()booleanisLocked()booleanisMovable()booleanisNotYetReached()booleanisParallelGroup()booleanisPending()booleanisPlanned()booleanisPostponedDueToBlackout()booleanisPostponedUntilEnvironmentsAreReserved()booleanisPreconditionEnabled()booleanisPreconditionInProgress()booleanisSkipped()booleanisSkippedInAdvance()booleanisStillExecutingScript(java.lang.String executionId)booleanisSupportedInWorkflow()booleanisTaskFailureHandlerEnabled()booleanisTaskGroup()booleanisUpdatable()booleanisWaitForScheduledStartDate()booleanisWaitingForInput()voidlock()ChangesmarkAsDone(java.lang.String targetId, TaskStatus status)booleanownerHasBeenReassigned(Task task)ChangespostponeUntilEnvironmentsAreReserved(java.util.Date postponeUntil)booleanpreconditionHasChanged(Task task)voidremoveWatcher(java.lang.String watcher)Changesreopen()voidreplaceTask(Task task)ChangesresetToPlanned()Changesretry(java.lang.String targetId)voidsetAttachments(java.util.List<Attachment> attachments)voidsetCheckAttributes(boolean checkAttributes)voidsetCiUid(java.lang.Integer ciUid)voidsetConfigurationUri(java.lang.String configurationUri)voidsetContainer(TaskContainer container)voidsetDelayDuringBlackout(boolean delayDuringBlackout)voidsetDueSoonNotified(boolean dueSoonNotified)voidsetExecutionId(java.lang.String executionId)voidsetFacets(java.util.List<Facet> facets)voidsetFailureHandler(java.lang.String failureHandler)voidsetFailuresCount(int failuresCount)voidsetFlagStatus(FlagStatus flagStatus)voidsetHasBeenDelayed(boolean hasBeenDelayed)voidsetHasBeenFlagged(boolean hasBeenFlagged)voidsetLocked(boolean locked)voidsetMaxCommentSize(int maxCommentSize)voidsetOriginalScheduledStartDate(java.util.Date originalDate)voidsetPostponedDueToBlackout(boolean delay)TasksetPostponedUntilEnvironmentsAreReserved(boolean postponedUntilEnvironmentsAreReserved)voidsetPrecondition(java.lang.String precondition)voidsetReleaseUid(java.lang.Integer releaseUid)voidsetScheduledStartDate(java.util.Date scheduledStartDate)voidsetStatus(TaskStatus status)voidsetSupportedInWorkflow(boolean supportedInWorkflow)voidsetTags(java.util.List<java.lang.String> tags)voidsetTaskFailureHandlerEnabled(boolean taskFailureHandlerEnabled)voidsetTaskRecoverOp(TaskRecoverOp taskRecoverOp)voidsetTeam(java.lang.String team)voidsetVariableMapping(java.util.Map<java.lang.String,java.lang.String> variableMapping)voidsetWaitForScheduledStartDate(boolean waitForScheduledStartDate)voidsetWatchers(java.util.Set<java.lang.String> watchers)booleanshouldFacetBeChecked()booleanshouldNotifyDueSoon()booleanshouldPreconditionBeChecked()Changesstart()ChangesstartPending(java.lang.String targetId)ChangesstartWithInput()booleanteamHasBeenReassigned(Task task)voidunlock()voidupdateComment(Comment originalComment, Comment updatedComment)-
Methods inherited from class com.xebialabs.xlrelease.domain.PlanItem
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, 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
-
-
-
-
Field Detail
-
CATEGORY_INPUT
public static final java.lang.String CATEGORY_INPUT
- See Also:
- Constant Field Values
-
CATEGORY_OUTPUT
public static final java.lang.String CATEGORY_OUTPUT
- See Also:
- Constant Field Values
-
DUE_SOON_THRESHOLD
public static final double DUE_SOON_THRESHOLD
- See Also:
- Constant Field Values
-
UNKNOWN_TASK_TYPE
public static final com.xebialabs.deployit.plugin.api.reflect.Type UNKNOWN_TASK_TYPE
-
IS_AUTOMATED_AND_IN_PROGRESS
public static final java.util.function.Predicate<Task> IS_AUTOMATED_AND_IN_PROGRESS
-
-
Method Detail
-
getConfigurationUri
public java.lang.String getConfigurationUri()
-
setConfigurationUri
public void setConfigurationUri(java.lang.String configurationUri)
-
getCiUid
public java.lang.Integer getCiUid()
-
setCiUid
public void setCiUid(java.lang.Integer ciUid)
-
getComments
public java.util.List<Comment> getComments()
-
getContainer
public TaskContainer getContainer()
-
setContainer
public void setContainer(TaskContainer container)
-
getStatus
public TaskStatus getStatus()
-
setStatus
public void setStatus(TaskStatus status)
-
getTeam
public java.lang.String getTeam()
-
hasTeam
public boolean hasTeam()
-
setTeam
public void setTeam(java.lang.String team)
-
getWatchers
public java.util.Set<java.lang.String> getWatchers()
-
setWatchers
public void setWatchers(java.util.Set<java.lang.String> watchers)
-
addWatcher
public void addWatcher(java.lang.String watcher)
-
removeWatcher
public void removeWatcher(java.lang.String watcher)
-
setPrecondition
public void setPrecondition(java.lang.String precondition)
-
getPrecondition
public java.lang.String getPrecondition()
-
getFailureHandler
public java.lang.String getFailureHandler()
-
getAbortScript
public java.lang.String getAbortScript() throws java.io.IOException- Throws:
java.io.IOException
-
setFailureHandler
public void setFailureHandler(java.lang.String failureHandler)
-
isTaskFailureHandlerEnabled
public boolean isTaskFailureHandlerEnabled()
-
setTaskFailureHandlerEnabled
public void setTaskFailureHandlerEnabled(boolean taskFailureHandlerEnabled)
-
getTaskRecoverOp
public TaskRecoverOp getTaskRecoverOp()
-
setTaskRecoverOp
public void setTaskRecoverOp(TaskRecoverOp taskRecoverOp)
-
getTags
public java.util.List<java.lang.String> getTags()
-
setTags
public void setTags(java.util.List<java.lang.String> tags)
-
isCheckAttributes
public boolean isCheckAttributes()
-
setCheckAttributes
public void setCheckAttributes(boolean checkAttributes)
-
setVariableMapping
public void setVariableMapping(java.util.Map<java.lang.String,java.lang.String> variableMapping)
-
getVariableMapping
public java.util.Map<java.lang.String,java.lang.String> getVariableMapping()
-
hasVariableMapping
public boolean hasVariableMapping()
-
setMaxCommentSize
public void setMaxCommentSize(int maxCommentSize)
-
getMaxCommentSize
public int getMaxCommentSize()
-
isDefaultTaskType
public static boolean isDefaultTaskType(com.xebialabs.deployit.plugin.api.reflect.Type type)
-
fromType
public static <T extends Task> T fromType(java.lang.String taskType)
-
fromType
public static <T extends Task> T fromType(com.xebialabs.deployit.plugin.api.reflect.Type taskType)
-
getPhase
public Phase getPhase()
-
start
public Changes start()
-
canStartNow
public boolean canStartNow()
-
canScheduleTaskStart
public boolean canScheduleTaskStart()
-
startPending
public Changes startPending(java.lang.String targetId)
-
startWithInput
public Changes startWithInput()
-
retry
public Changes retry(java.lang.String targetId)
-
setScheduledStartDate
public void setScheduledStartDate(java.util.Date scheduledStartDate)
- Overrides:
setScheduledStartDatein classPlanItem
-
shouldFacetBeChecked
public boolean shouldFacetBeChecked()
-
canBeBackup
public boolean canBeBackup()
-
shouldPreconditionBeChecked
public boolean shouldPreconditionBeChecked()
-
postponeUntilEnvironmentsAreReserved
public Changes postponeUntilEnvironmentsAreReserved(java.util.Date postponeUntil)
-
markAsDone
public Changes markAsDone(java.lang.String targetId, TaskStatus status)
- Parameters:
targetId- since tasks nest, this can either be the id of this task or the id of one of its children
-
fail
public Changes fail(java.lang.String targetId, java.lang.String failReason)
-
fail
public Changes fail(java.lang.String targetId, java.lang.String failReason, com.xebialabs.xlrelease.user.User user)
-
fail
public Changes fail(java.lang.String targetId, java.lang.String failReason, boolean fromAbort)
-
fail
public Changes fail(java.lang.String targetId, java.lang.String failReason, com.xebialabs.xlrelease.user.User user, boolean fromAbort)
-
reopen
public Changes reopen()
-
abort
public Changes abort()
-
hasBeenStarted
public boolean hasBeenStarted()
- Specified by:
hasBeenStartedin classPlanItem
-
hasBeenFlagged
public boolean hasBeenFlagged()
-
getFlaggedCount
public int getFlaggedCount()
-
getDelayedCount
public int getDelayedCount()
-
hasBeenDelayed
public boolean hasBeenDelayed()
-
getFailuresCount
public int getFailuresCount()
-
setHasBeenFlagged
public void setHasBeenFlagged(boolean hasBeenFlagged)
-
setHasBeenDelayed
public void setHasBeenDelayed(boolean hasBeenDelayed)
-
setFailuresCount
public void setFailuresCount(int failuresCount)
-
isDoneInAdvance
public boolean isDoneInAdvance()
-
isDefunct
public boolean isDefunct()
-
isUpdatable
public boolean isUpdatable()
- Specified by:
isUpdatablein classPlanItem
-
isNotYetReached
public boolean isNotYetReached()
-
isPlanned
public boolean isPlanned()
-
isInProgress
public boolean isInProgress()
-
isPending
public boolean isPending()
-
isWaitingForInput
public boolean isWaitingForInput()
-
isFailed
public boolean isFailed()
-
isFailing
public boolean isFailing()
-
isCompletedInAdvance
public boolean isCompletedInAdvance()
-
isSkipped
public boolean isSkipped()
-
isSkippedInAdvance
public boolean isSkippedInAdvance()
-
isPreconditionInProgress
public boolean isPreconditionInProgress()
-
isFailureHandlerInProgress
public boolean isFailureHandlerInProgress()
-
isAbortScriptInProgress
public boolean isAbortScriptInProgress()
-
isFacetInProgress
public boolean isFacetInProgress()
-
hasAbortScript
public boolean hasAbortScript()
-
isMovable
public boolean isMovable()
-
isAssignedTo
public boolean isAssignedTo(Team team)
-
isGate
public boolean isGate()
-
isTaskGroup
public boolean isTaskGroup()
-
isParallelGroup
public boolean isParallelGroup()
-
getAttachments
public java.util.List<Attachment> getAttachments()
-
setAttachments
public void setAttachments(java.util.List<Attachment> attachments)
-
isPreconditionEnabled
public boolean isPreconditionEnabled()
-
isFailureHandlerEnabled
public boolean isFailureHandlerEnabled()
-
getExecutionId
public java.lang.String getExecutionId()
-
setExecutionId
public void setExecutionId(java.lang.String executionId)
-
generateExecutionId
public void generateExecutionId()
-
deleteAttachment
public void deleteAttachment(java.lang.String attachmentId)
-
resetToPlanned
public Changes resetToPlanned()
-
setFlagStatus
public void setFlagStatus(FlagStatus flagStatus)
- Overrides:
setFlagStatusin classPlanItem
-
getRelease
public Release getRelease()
- Specified by:
getReleasein classPlanItem
-
getReleaseUid
public java.lang.Integer getReleaseUid()
- Specified by:
getReleaseUidin classPlanItem
-
setReleaseUid
public void setReleaseUid(java.lang.Integer releaseUid)
- Specified by:
setReleaseUidin classPlanItem
-
getDisplayPath
public java.lang.String getDisplayPath()
- Specified by:
getDisplayPathin classPlanItem
-
getReleaseOwner
public java.lang.String getReleaseOwner()
-
getAllTasks
public java.util.List<Task> getAllTasks()
-
getChildren
public java.util.List<PlanItem> getChildren()
- Specified by:
getChildrenin classPlanItem
-
accept
public void accept(ReleaseVisitor visitor)
- Specified by:
acceptin interfaceVisitableItem
-
getVariableUsages
public java.util.List<UsagePoint> getVariableUsages()
- Specified by:
getVariableUsagesin classPlanItem
-
freezeVariables
public java.util.Set<java.lang.String> freezeVariables(Changes changes, boolean freezeEvenIfUnresolved)
-
getInputVariables
public java.util.List<Variable> getInputVariables()
-
getReferencedVariables
public java.util.List<Variable> getReferencedVariables()
-
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)
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.
-
isWaitForScheduledStartDate
public boolean isWaitForScheduledStartDate()
-
setWaitForScheduledStartDate
public void setWaitForScheduledStartDate(boolean waitForScheduledStartDate)
-
isDelayDuringBlackout
public boolean isDelayDuringBlackout()
-
setDelayDuringBlackout
public void setDelayDuringBlackout(boolean delayDuringBlackout)
-
checkDatesValidity
public void checkDatesValidity()
-
isAutomated
public boolean isAutomated()
-
ownerHasBeenReassigned
public boolean ownerHasBeenReassigned(Task task)
-
teamHasBeenReassigned
public boolean teamHasBeenReassigned(Task task)
-
delayDuringBlackoutHasChanged
public boolean delayDuringBlackoutHasChanged(Task task)
-
failureHandlerHasChanged
public boolean failureHandlerHasChanged(Task task)
-
preconditionHasChanged
public boolean preconditionHasChanged(Task task)
-
getTaskType
public com.xebialabs.deployit.plugin.api.reflect.Type getTaskType()
-
isStillExecutingScript
public boolean isStillExecutingScript(java.lang.String executionId)
-
isPostponedDueToBlackout
public boolean isPostponedDueToBlackout()
-
setPostponedDueToBlackout
public void setPostponedDueToBlackout(boolean delay)
-
getOriginalScheduledStartDate
public java.util.Date getOriginalScheduledStartDate()
-
setOriginalScheduledStartDate
public void setOriginalScheduledStartDate(java.util.Date originalDate)
-
isDueSoon
public boolean isDueSoon()
-
getElapsedDurationFraction
public double getElapsedDurationFraction()
-
shouldNotifyDueSoon
public boolean shouldNotifyDueSoon()
-
isDueSoonNotified
public boolean isDueSoonNotified()
-
setDueSoonNotified
public void setDueSoonNotified(boolean dueSoonNotified)
-
deleteTask
public void deleteTask(Task task)
-
replaceTask
public void replaceTask(Task task)
-
findComment
public Comment findComment(java.lang.String commentId)
-
clearComments
public void clearComments()
-
isSupportedInWorkflow
public boolean isSupportedInWorkflow()
-
setSupportedInWorkflow
public void setSupportedInWorkflow(boolean supportedInWorkflow)
-
getFacets
public java.util.List<Facet> getFacets()
-
setFacets
public void setFacets(java.util.List<Facet> facets)
-
getUrl
public java.lang.String getUrl()
-
isPostponedUntilEnvironmentsAreReserved
public boolean isPostponedUntilEnvironmentsAreReserved()
-
setPostponedUntilEnvironmentsAreReserved
public Task setPostponedUntilEnvironmentsAreReserved(boolean postponedUntilEnvironmentsAreReserved)
-
-