com.xebialabs.deployit.engine.api

Interface ControlService

@Path(value="/control")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public interface ControlService

Provides access to control methods defined on CIs.

Method Summary

Modifier and Type	Method and Description
java.lang.String	createTask(Control control) Creates the control task
Control	prepare(java.lang.String controlName, java.lang.String id) Returns a parameter object for the task that will execute the control task method.

Method Detail

prepare

@GET
 @Path(value="prepare/{controlName}/{id:.+}")
Control prepare(@PathParam(value="controlName")
                                                                   java.lang.String controlName,
                                                                   @PathParam(value="id")
                                                                   java.lang.String id)

Returns a parameter object for the task that will execute the control task method.

Parameters:

controlName - The name of the control method to execute.

id - the CI to execute the control method on

Returns:

a Control parameter object.

RestDetails:

The returned object can be used in the call to /control.

Permission:

controltask#execute

ApiDetails:

The returned object is used for a call to createTask(com.xebialabs.deployit.engine.api.dto.Control).

createTask

@POST
java.lang.String createTask(Control control)

Creates the control task

Parameters:

control - the Control parameter object.

Returns:

a reference to a Task ID that can be executed by the TaskService.

RestDetails:

for the object returned by invoking /control/prepare.

Permission:

controltask#execute

ApiDetails:

for the object returned by prepare(String, String)