Package com.xebialabs.xlrelease.domain

Class NotificationTask

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.NotificationTask

All Implemented Interfaces:

com.xebialabs.deployit.plugin.api.udm.ConfigurationItem, Lockable, VisitableItem, Serializable, Comparable<com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem>

@Metadata(label="Notification",
          versioned=false,
          description="Sends notification messages via email to specified recipients")
public class NotificationTask
extends Task

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.xebialabs.xlrelease.domain.Task

CATEGORY_INPUT, CATEGORY_OUTPUT, DUE_SOON_THRESHOLD, IS_AUTOMATED_AND_IN_PROGRESS, UNKNOWN_TASK_TYPE

Fields inherited from class com.xebialabs.xlrelease.domain.PlanItem

BY_TITLE

Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem

SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD

Constructor Summary

Constructors

Constructor	Description
NotificationTask()

Method Summary

Modifier and Type	Method	Description
Set<String>	freezeVariablesInCustomFields(Map<String,ValueWithInterpolation> variables, Map<String,String> passwordVariables, Changes changes, boolean freezeEvenIfUnresolved)	To be overridden in child classes with custom fields that can contain variables.
Set<String>	getAddresses()
Set<String>	getBcc()
String	getBody()
Set<String>	getCc()
String	getFrom()
MailPriority	getPriority()
String	getReplyTo()
String	getSenderPassword()
String	getSenderUsername()
String	getSubject()
List<UsagePoint>	getVariableUsages()
void	setAddresses(Set<String> addresses)
void	setBcc(Set<String> bcc)
void	setBody(String body)
void	setCc(Set<String> cc)
void	setFrom(String from)
void	setPriority(MailPriority priority)
void	setReplyTo(String replyTo)
void	setSenderPassword(String senderPassword)
void	setSenderUsername(String senderUsername)
void	setSubject(String subject)

Methods inherited from class com.xebialabs.xlrelease.domain.Task

abort, accept, addWatcher, canBeBackup, canScheduleTaskStart, canStartNow, checkDatesValidity, clearComments, clearModificationAttributes, delayDuringBlackoutHasChanged, deleteAttachment, deleteTask, fail, fail, fail, fail, failureHandlerHasChanged, findComment, freezeVariables, fromType, fromType, generateExecutionId, getAbortScript, getAllTasks, getAttachments, getChildren, getCiUid, getComments, getContainer, getDelayedCount, getDisplayPath, getDocumentationPage, getElapsedDurationFraction, getExecutionId, getFacets, getFailureHandler, getFailuresCount, getFlaggedCount, getInputVariables, getLastStatusChangeBy, getMaxCommentSize, getOriginalScheduledStartDate, getPhase, getPrecondition, getPreconditionType, getReferencedVariableKeys, getReferencedVariables, getRelease, getReleaseOwner, getReleaseUid, getStatus, getStatusLine, getTags, getTaskRecoverOp, getTaskType, getTeam, getUrl, getVariableMapping, getWatchers, hasAbortScript, hasBeenDelayed, hasBeenFlagged, hasBeenStarted, 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, markAsDone, markAsFailing, ownerHasBeenReassigned, postponeUntilEnvironmentsAreReserved, preconditionHasChanged, removeWatcher, reopen, replaceTask, resetToPlanned, retry, setAttachments, setCheckAttributes, setCiUid, setContainer, setDelayDuringBlackout, setDocumentationPage, setDueSoonNotified, setExecutionId, setFacets, setFailureHandler, setFailuresCount, setFlagStatus, setHasBeenDelayed, setHasBeenFlagged, setLocked, setMaxCommentSize, setOriginalScheduledStartDate, setPostponedDueToBlackout, setPostponedUntilEnvironmentsAreReserved, setPrecondition, setPreconditionType, setReleaseUid, setScheduledStartDate, setStatus, setStatusLine, setSupportedInWorkflow, setTags, setTaskFailureHandlerEnabled, setTaskRecoverOp, setTeam, setVariableMapping, setWaitForScheduledStartDate, setWatchers, shouldFacetBeChecked, shouldNotifyDueSoon, shouldPreconditionBeChecked, start, startPending, startWithInput, teamHasBeenReassigned, unlock, updateComment

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NotificationTask

public NotificationTask()

Method Details

freezeVariablesInCustomFields

public Set<String> freezeVariablesInCustomFields(Map<String,ValueWithInterpolation> variables,
 Map<String,String> passwordVariables,
 Changes changes,
 boolean freezeEvenIfUnresolved)

Description copied from class: Task

To be overridden in child classes with custom fields that can contain variables.

Apply VariableHelper.replaceAll(Object, Map, Set, boolean) to each field; if child entities are modified, add them to changes.

Overrides:

freezeVariablesInCustomFields in class Task

getAddresses

public Set<String> getAddresses()

setAddresses

public void setAddresses(Set<String> addresses)

getSubject

public String getSubject()

setSubject

public void setSubject(String subject)

getBody

public String getBody()

setBody

public void setBody(String body)

getCc

public Set<String> getCc()

setCc

public void setCc(Set<String> cc)

getBcc

public Set<String> getBcc()

setBcc

public void setBcc(Set<String> bcc)

getReplyTo

public String getReplyTo()

setReplyTo

public void setReplyTo(String replyTo)

getFrom

public String getFrom()

setFrom

public void setFrom(String from)

getSenderUsername

public String getSenderUsername()

setSenderUsername

public void setSenderUsername(String senderUsername)

getSenderPassword

public String getSenderPassword()

setSenderPassword

public void setSenderPassword(String senderPassword)

getPriority

public MailPriority getPriority()

setPriority

public void setPriority(MailPriority priority)

getVariableUsages

public List<UsagePoint> getVariableUsages()

Overrides:

getVariableUsages in class Task