com.xebialabs.deployit.task
Class Task

java.lang.Object
  extended by com.xebialabs.deployit.task.Task
All Implemented Interfaces:
java.io.Serializable, java.lang.Runnable
Direct Known Subclasses:
ControlTask, DeploymentTask, GarbageCollectionTask

public abstract class Task
extends java.lang.Object
implements java.io.Serializable, java.lang.Runnable

See Also:
Serialized Form

Nested Class Summary
static class Task.State
           
 class Task.TaskStateChangeEvent
           
 
Constructor Summary
Task(java.util.List<? extends com.xebialabs.deployit.plugin.api.execution.Step<?>> steps)
           
 
Method Summary
 void abort()
          Aborts a task when it is executing.
 void cancel()
          Cancels a task that has not started executing or that has stopped executing (but is not DONE).
 void destroy()
          Destroys a task.
 void doAfterTaskStateChangedToAborted()
          override this method if something needs to be executed/saved/deleted after the state is changed to ABORTED
 void doAfterTaskStateChangedToDone()
          override this method if something needs to be executed/saved/deleted after the state is changed to DONE
protected  boolean executeSteps()
           
 java.util.Calendar getCompletionDate()
           
 int getCurrentStepNr()
           
 int getFailureCount()
           
 java.lang.String getId()
           
 java.lang.String getLabel()
           
 int getNrOfSteps()
           
 java.lang.String getOwner()
           
 org.springframework.security.core.Authentication getOwnerCredentials()
           
 java.util.Calendar getStartDate()
           
 Task.State getState()
           
 TaskStep getStep(int stepNr)
           
 java.util.List<TaskStep> getSteps()
           
 java.util.concurrent.FutureTask<java.lang.Object> getWrappingTask()
           
 boolean isExecuting()
           
 boolean isReadyForExecution()
           
 void moveStep(int stepNr, int newPosition)
           
 void performPreFlightChecks()
          Override this method when pre-flight checks need to be performed for task.
 void processAfterRecovery()
           
 void run()
           
 void setId(java.lang.String id)
           
 void setLabel(java.lang.String label)
           
 void setOwner(java.lang.String owner)
           
 void setOwnerCredentials(org.springframework.security.core.Authentication ownerCredentials)
           
 void setWrappingTask(java.util.concurrent.FutureTask<java.lang.Object> wrappingTask)
           
 void stop()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Task

public Task(java.util.List<? extends com.xebialabs.deployit.plugin.api.execution.Step<?>> steps)
Method Detail

executeSteps

protected boolean executeSteps()

moveStep

public void moveStep(int stepNr,
                     int newPosition)

run

public void run()
Specified by:
run in interface java.lang.Runnable

getFailureCount

public int getFailureCount()

doAfterTaskStateChangedToDone

public void doAfterTaskStateChangedToDone()
override this method if something needs to be executed/saved/deleted after the state is changed to DONE


doAfterTaskStateChangedToAborted

public void doAfterTaskStateChangedToAborted()
override this method if something needs to be executed/saved/deleted after the state is changed to ABORTED


performPreFlightChecks

public void performPreFlightChecks()
Override this method when pre-flight checks need to be performed for task.


stop

public void stop()

abort

public void abort()
Aborts a task when it is executing.


cancel

public void cancel()
Cancels a task that has not started executing or that has stopped executing (but is not DONE).


destroy

public void destroy()
Destroys a task. Cleans up any temporary files needed for execution of the task.


isReadyForExecution

public boolean isReadyForExecution()

isExecuting

public boolean isExecuting()

getSteps

public java.util.List<TaskStep> getSteps()

setWrappingTask

public void setWrappingTask(java.util.concurrent.FutureTask<java.lang.Object> wrappingTask)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)

getOwner

public java.lang.String getOwner()

setOwner

public void setOwner(java.lang.String owner)

getOwnerCredentials

public org.springframework.security.core.Authentication getOwnerCredentials()

setOwnerCredentials

public void setOwnerCredentials(org.springframework.security.core.Authentication ownerCredentials)

getStartDate

public java.util.Calendar getStartDate()

getCompletionDate

public java.util.Calendar getCompletionDate()

getCurrentStepNr

public int getCurrentStepNr()

getNrOfSteps

public int getNrOfSteps()

getStep

public TaskStep getStep(int stepNr)

getWrappingTask

public java.util.concurrent.FutureTask<java.lang.Object> getWrappingTask()

getState

public Task.State getState()

processAfterRecovery

public void processAfterRecovery()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object