Package com.xebialabs.deployit.engine.api

Interface InspectionService

@Path("/inspection") @Consumes({"application/xml","application/json"}) @Produces({"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

    Modifier and Type
    Method
    Description
    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(String id)
    Initializes the task parameter object for inspection on a CI.
    List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>
    retrieveInspectionResults(String taskId)
    Retrieve the inspection results

  • Method Details

    • prepare

      @POST @Path("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("prepare/{id:.+}") Inspection prepare(@PathParam("id") 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 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("retrieve/{taskId}") List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> retrieveInspectionResults(@PathParam("taskId") String taskId)
      Retrieve the inspection results
      Parameters:
      taskId - the Task ID of the task that ran the inspection.
      Returns:
      the list of CIs that were inspected.