Package com.xebialabs.deployit.core.api

Interface WorkersService

@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
@Path("workers")
public interface WorkersService

Method Summary

Modifier and Type	Method	Description
List<ai.digital.deploy.sql.model.WorkerInfo>	listWorkers(com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)	Lists all workers
void	removeWorker(Integer workerId)	Remove a disconnected worker (and possibly related tasks) from the system.
List<String>	reregisterGhostTasks()	Find ghost tasks on a worker (tasks that are not registered in the system) and re-register them.
void	shutdownWorker(Integer workerId)	Gracefully shutdown a worker by id.
void	shutdownWorkers(List<String> workers)	Forcefully shutdown workers by address, if no address provided all of workers will shutdown.

Method Details

shutdownWorkers

@DELETE
void shutdownWorkers(@QueryParam("worker")
 List<String> workers)

Forcefully shutdown workers by address, if no address provided all of workers will shutdown.

shutdownWorker

@PUT
@Path("{workerId}/shutdown")
void shutdownWorker(@PathParam("workerId")
 Integer workerId)

Gracefully shutdown a worker by id.

removeWorker

@DELETE
@Path("{workerId}")
void removeWorker(@PathParam("workerId")
 Integer workerId)

Remove a disconnected worker (and possibly related tasks) from the system.

listWorkers

@GET
List<ai.digital.deploy.sql.model.WorkerInfo> listWorkers(@BeanParam
 com.xebialabs.deployit.engine.api.dto.Paging paging,
 @QueryParam("order")
 com.xebialabs.deployit.engine.api.dto.Ordering order)

Lists all workers

reregisterGhostTasks

@PATCH
@Path("tasks/reregister")
List<String> reregisterGhostTasks()

Find ghost tasks on a worker (tasks that are not registered in the system) and re-register them.

Returns:

The ghost tasks found and reregistered.