com.xebialabs.deployit.core.rest.api
Class TaskResource

java.lang.Object
  com.xebialabs.deployit.core.rest.secured.AbstractSecuredResource
      com.xebialabs.deployit.core.rest.api.TaskResource

All Implemented Interfaces:

com.xebialabs.deployit.engine.api.TaskService

@Controller
public class TaskResource
extends AbstractSecuredResource
implements com.xebialabs.deployit.engine.api.TaskService

Constructor Summary

TaskResource()

Method Summary

void	abort(java.lang.String taskId)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	addPause(java.lang.String taskId, int stepNr)
void	archive(java.lang.String taskId)
com.xebialabs.deployit.engine.api.execution.TaskState	assign(java.lang.String taskId, java.lang.String owner)
void	cancel(java.lang.String taskId)
java.util.List<com.xebialabs.deployit.engine.api.execution.TaskWithSteps>	export(org.joda.time.LocalDate begin, org.joda.time.LocalDate end)
java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState>	getAllCurrentTasks() Lists all unfinished tasks in the system.
java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState>	getMyCurrentTasks() Lists all unfinished tasks for the current user.
com.xebialabs.deployit.engine.api.execution.StepState	getStep(java.lang.String taskId, int stepNr, org.joda.time.DateTime ifModifiedSince)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	getSteps(java.lang.String taskId)
com.xebialabs.deployit.engine.api.execution.TaskState	getTask(java.lang.String taskId)
protected boolean	hasBeenModifiedSince(com.xebialabs.deployit.engine.api.execution.StepState step, org.joda.time.DateTime ifModifiedSince)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	moveStep(java.lang.String taskId, int stepNr, int newPosition)
java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState>	query(org.joda.time.LocalDate begin, org.joda.time.LocalDate end)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	skip(java.lang.String taskId, java.util.List<java.lang.Integer> stepIds)
void	start(java.lang.String taskId)
void	stop(java.lang.String taskId)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	unskip(java.lang.String taskId, java.util.List<java.lang.Integer> stepIds)

Methods inherited from class com.xebialabs.deployit.core.rest.secured.AbstractSecuredResource

checkPermission, checkPermission, hasPermission

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskResource

public TaskResource()

Method Detail

start

public void start(java.lang.String taskId)

Specified by:

start in interface com.xebialabs.deployit.engine.api.TaskService

cancel

public void cancel(java.lang.String taskId)

Specified by:

cancel in interface com.xebialabs.deployit.engine.api.TaskService

archive

public void archive(java.lang.String taskId)

Specified by:

archive in interface com.xebialabs.deployit.engine.api.TaskService

stop

public void stop(java.lang.String taskId)

Specified by:

stop in interface com.xebialabs.deployit.engine.api.TaskService

abort

public void abort(java.lang.String taskId)

Specified by:

abort in interface com.xebialabs.deployit.engine.api.TaskService

getTask

public com.xebialabs.deployit.engine.api.execution.TaskState getTask(java.lang.String taskId)

Specified by:

getTask in interface com.xebialabs.deployit.engine.api.TaskService

assign

public com.xebialabs.deployit.engine.api.execution.TaskState assign(java.lang.String taskId,
                                                                    java.lang.String owner)

Specified by:

assign in interface com.xebialabs.deployit.engine.api.TaskService

skip

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps skip(java.lang.String taskId,
                                                                      java.util.List<java.lang.Integer> stepIds)

Specified by:

skip in interface com.xebialabs.deployit.engine.api.TaskService

unskip

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps unskip(java.lang.String taskId,
                                                                        java.util.List<java.lang.Integer> stepIds)

Specified by:

unskip in interface com.xebialabs.deployit.engine.api.TaskService

moveStep

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps moveStep(java.lang.String taskId,
                                                                          int stepNr,
                                                                          int newPosition)

Specified by:

moveStep in interface com.xebialabs.deployit.engine.api.TaskService

addPause

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps addPause(java.lang.String taskId,
                                                                          int stepNr)

Specified by:

addPause in interface com.xebialabs.deployit.engine.api.TaskService

getStep

public com.xebialabs.deployit.engine.api.execution.StepState getStep(java.lang.String taskId,
                                                                     int stepNr,
                                                                     org.joda.time.DateTime ifModifiedSince)

Specified by:

getStep in interface com.xebialabs.deployit.engine.api.TaskService

hasBeenModifiedSince

protected boolean hasBeenModifiedSince(com.xebialabs.deployit.engine.api.execution.StepState step,
                                       org.joda.time.DateTime ifModifiedSince)

getMyCurrentTasks

public java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState> getMyCurrentTasks()

Lists all unfinished tasks for the current user.

NOTE: this method is invoked from the GUI when restarting the UI after a crash. Therefore, it should only return the tasks for the currently logged in user to prevent logging in as an administrator and seeing all tasks in the system open in your GUI.

If you do need the latter functionality, see getAllUnfinishedTasks().

Specified by:

getMyCurrentTasks in interface com.xebialabs.deployit.engine.api.TaskService

getAllCurrentTasks

public java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState> getAllCurrentTasks()

Lists all unfinished tasks in the system.

Specified by:

getAllCurrentTasks in interface com.xebialabs.deployit.engine.api.TaskService

getSteps

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps getSteps(java.lang.String taskId)

Specified by:

getSteps in interface com.xebialabs.deployit.engine.api.TaskService

query

public java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState> query(org.joda.time.LocalDate begin,
                                                                                   org.joda.time.LocalDate end)

Specified by:

query in interface com.xebialabs.deployit.engine.api.TaskService

export

public java.util.List<com.xebialabs.deployit.engine.api.execution.TaskWithSteps> export(org.joda.time.LocalDate begin,
                                                                                        org.joda.time.LocalDate end)

Specified by:

export in interface com.xebialabs.deployit.engine.api.TaskService