com.xebialabs.deployit.engine.api

Interface SatelliteService

@Path(value="/satellite")
 @Produces(value={"text/xml","application/xml","application/json"})
public interface SatelliteService

Services related to XL Satellites and hosts attached to them.

Method Summary

Modifier and Type	Method and 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(value="info/{id:.+}")
SatelliteInfo getInfo(@PathParam(value="id")
                                                        java.lang.String ciId)

Returns information about the configuration of the satellite. For example: version.

Returns:

an information object.

getInfos

@GET
 @Path(value="info")
java.util.List<SatelliteInfo> getInfos(@QueryParam(value="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(value="hosts/{id:.+}")
java.util.List<ConfigurationItemId> listHosts(@PathParam(value="id")
                                                                                 java.lang.String ciId,
                                                                                 @QueryParam(value="name")
                                                                                 java.lang.String name,
                                                                                 @BeanParam
                                                                                 com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                                 @QueryParam(value="order")
                                                                                 com.xebialabs.deployit.engine.api.dto.Ordering order)

countHosts

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