Package com.xebialabs.deployit.engine.api

Interface SatelliteService

  • @Path("/satellite")
@Produces({"text/xml","application/xml","application/json"})
public interface SatelliteService
    Services related to XL Satellites and hosts attached to them.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Integer countHosts​(java.lang.String ciId, java.lang.String name)  
      SatelliteInfo getInfo​(java.lang.String ciId)
      Returns information about the configuration of the satellite.
      java.util.List<SatelliteInfo> getInfos​(java.util.List<java.lang.String> ids)
      Returns information about the configuration of the satellite.
      java.util.List<ConfigurationItemId> listHosts​(java.lang.String ciId, java.lang.String name, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)  

    • Method Detail

      • getInfo

        @GET
@Path("info/{id:.+}")
SatelliteInfo getInfo​(@PathParam("id")
                      java.lang.String ciId)
        Returns information about the configuration of the satellite. For example: version.
        Returns:
        an information object.

      • getInfos

        @GET
@Path("info")
java.util.List<SatelliteInfo> getInfos​(@QueryParam("ids")
                                       java.util.List<java.lang.String> ids)
        Returns information about the configuration of the satellite. For example: version.
        Returns:
        an list of information objects.

      • listHosts

        @GET
@Path("hosts/{id:.+}")
java.util.List<ConfigurationItemId> listHosts​(@PathParam("id")
                                              java.lang.String ciId,
                                              @QueryParam("name")
                                              java.lang.String name,
                                              @BeanParam
                                              com.xebialabs.deployit.engine.api.dto.Paging paging,
                                              @QueryParam("order")
                                              com.xebialabs.deployit.engine.api.dto.Ordering order)

      • countHosts

        @GET
@Path("hosts/count/{id:.+}")
java.lang.Integer countHosts​(@PathParam("id")
                             java.lang.String ciId,
                             @QueryParam("name")
                             java.lang.String name)