Package com.xebialabs.deployit.core.rest.api

Class TaskResource

java.lang.Object

com.xebialabs.deployit.core.rest.secured.AbstractSecuredResource

com.xebialabs.deployit.core.rest.api.AbstractTaskRestrictedResource

com.xebialabs.deployit.core.rest.api.AbstractTaskResource

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

All Implemented Interfaces:

com.xebialabs.deployit.engine.api.TaskService

@Service
public class TaskResource
extends AbstractTaskResource
implements com.xebialabs.deployit.engine.api.TaskService

Nested Class Summary

Nested classes/interfaces inherited from class com.xebialabs.deployit.core.rest.api.AbstractTaskResource

AbstractTaskResource.NotModifiedException

Field Summary

Fields inherited from class com.xebialabs.deployit.core.rest.api.AbstractTaskResource

controlTaskService, engine, logger, pendingTaskRepository, stepLogRetriever, taskQueueService, taskRepository

Fields inherited from class com.xebialabs.deployit.core.rest.api.AbstractTaskRestrictedResource

paginationService, reportGenerator, repositoryService, taskArchive, taskArchiveQueue

Constructor Summary

Constructors

Constructor	Description
TaskResource()

Method Summary

Modifier and Type	Method	Description
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	addPause(java.lang.String taskId, int stepNr)
com.xebialabs.deployit.engine.api.execution.TaskState	assign(java.lang.String taskId, java.lang.String owner)
java.util.stream.Stream<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 void	pause(java.lang.String taskId, int stepNr)
java.util.stream.Stream<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)
protected com.xebialabs.deployit.engine.api.execution.TaskWithBlock	skip(java.lang.String taskId, java.util.List<java.lang.Integer> stepIds, boolean skip)
com.xebialabs.deployit.engine.api.execution.TaskState	takeover(java.lang.String taskId, java.lang.String owner)
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.api.AbstractTaskResource

abort, addLogs, archive, calledByOwner, cancel, checkForMissingPermission, checkOwnership, checkPermission, doAssign, doTakeover, forceCancel, forceCancelTasks, getSerializableTask, hasBeenModifiedSince, isNotCalledByOwner, pendingOrActiveOrArchivedTask, pendingOrLiveOrArchivedTask, purge, schedule, search, searchList, setEngine, setPendingTaskRepository, setTaskArchive, setTaskArchiveQueue, setTaskRepository, start, stop, toSearchParameters, viewAbleTask

Methods inherited from class com.xebialabs.deployit.core.rest.api.AbstractTaskRestrictedResource

checkAccessTo, hasTaskPermission, setPaginationService, setReportGenerator

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

checkPermission, checkPermission, checkPermissions, checkPermissions, checkReadPermission, hasPermission, hasPermission, hasReadPermission, setRoleService

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xebialabs.deployit.engine.api.TaskService

abort, archive, cancel, schedule, start, stop

Constructor Detail

TaskResource

public TaskResource()

Method Detail

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

takeover

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

Specified by:

takeover 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

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

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.stream.Stream<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.stream.Stream<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

skip

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

pause

protected void pause(java.lang.String taskId,
                     int stepNr)

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