com.xebialabs.deployit.engine.api

Interface InspectionService

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

Inspects middleware. Provides services to discover your topology and resources and synchronize them with the state currently known in XL Deploy.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	createTask(Inspection inspection) Creates the inspection task
Inspection	prepare(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci) Initializes the task parameter object for inspection on a CI.
Inspection	prepare(java.lang.String id) Initializes the task parameter object for inspection on a CI.
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	retrieveInspectionResults(java.lang.String taskId) Retrieved the inspection results

Method Detail

prepare

@POST
@Path(value="prepare")
Inspection prepare(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)

Initializes the task parameter object for inspection on a CI.

Parameters:

ci - The CI to inspect. For example, the root node of a middleware topology.

Returns:

an Inspection parameter object.

Permission:

discovery

prepare

@GET
@Path(value="prepare/{id:.*?}")
Inspection prepare(@PathParam(value="id")
                          java.lang.String id)

Initializes the task parameter object for inspection on a CI.

Parameters:

id - The id of the CI to inspect. For example, the root node of a middleware topology.

Returns:

an Inspection parameter object.

Permission:

discovery

createTask

@POST
java.lang.String createTask(Inspection inspection)

Creates the inspection task

Parameters:

inspection - the inspection parameter object

Returns:

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

RestDetails:

for the object returned by /inspection/prepare

Permission:

discovery

ApiDetails:

for the object returned by prepare(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem)

retrieveInspectionResults

@POST
@Path(value="retrieve/{taskId}")
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> retrieveInspectionResults(@PathParam(value="taskId")
                                                                                                          java.lang.String taskId)

Retrieved the inspection results

Parameters:

taskId - the Task ID of the task that ran the inspection.

Returns:

the list of CIs that were inspected.