IHost (cloudconductor-api 2.7 API)

All Superinterfaces:

IDefaultApi<Host>
```
@Path(value="/hosts")
public interface IHost
extends IDefaultApi<Host>
```
Copyright 2013 Cinovo AG

Author:

psigloch

Method Summary

Methods
Modifier and Type	Method and Description
`Service[]`	`getServices(String host)`
`Boolean`	`inSync(String host)` Checks whether the host and template are in sync or not
`void`	`removeService(String host, String service)` Delete the given service from the host
`javax.ws.rs.core.Response`	`restartService(String host, String service)` Restarts a given service on a host, if the host supports the service
`void`	`setService(String host, String name, Service service)` Add a new service to the host or modify an existing service
`javax.ws.rs.core.Response`	`startService(String host, String service)` Starts a given service on a host, if the host supports the service
`javax.ws.rs.core.Response`	`stopService(String host, String service)` Stops a given service on a host, if the host supports the service

Methods inherited from interface de.cinovo.cloudconductor.api.interfaces.IDefaultApi
delete, get, get, save

Method Detail

getServices

@GET
@Path(value="/{host}/services")
@Produces(value="application/json;charset=UTF-8")
Service[] getServices(@PathParam(value="host")
                                      String host)

Parameters:: host - the host name
Returns:: collection of services provided by the host

setService

@PUT
@Path(value="/{host}/services/{service}")
@Consumes(value="application/json;charset=UTF-8")
@Produces(value="application/json;charset=UTF-8")
void setService(@PathParam(value="host")
                                         String host,
                                         @PathParam(value="service")
                                         String name,
                                         Service service)

Add a new service to the host or modify an existing service

Parameters:: host - the host name; name - the service name; service - the service

removeService

@DELETE
@Path(value="/{host}/services/{service}")
@Consumes(value="application/json;charset=UTF-8")
@Produces(value="application/json;charset=UTF-8")
void removeService(@PathParam(value="host")
                                               String host,
                                               @PathParam(value="service")
                                               String service)

Delete the given service from the host

Parameters:: host - the host name; service - the service name

inSync

@GET
@Path(value="/{host}/synced")
@Produces(value="application/json;charset=UTF-8")
Boolean inSync(@PathParam(value="host")
                               String host)

Checks whether the host and template are in sync or not

Parameters:: host - the host name
Returns:: whether host packages are in sync with template or not

startService

@PUT
@Path(value="/{host}/services/{service}/start")
@Produces(value="application/json;charset=UTF-8")
javax.ws.rs.core.Response startService(@PathParam(value="host")
                                                       String host,
                                                       @PathParam(value="service")
                                                       String service)

Starts a given service on a host, if the host supports the service

Parameters:: host - the host name; service - the service name
Returns:: a response

stopService

@PUT
@Path(value="/{host}/services/{service}/stop")
@Produces(value="application/json;charset=UTF-8")
javax.ws.rs.core.Response stopService(@PathParam(value="host")
                                                      String host,
                                                      @PathParam(value="service")
                                                      String service)

Stops a given service on a host, if the host supports the service

Parameters:: host - the host name; service - the service name
Returns:: a response

restartService

@PUT
@Path(value="/{host}/services/{service}/restart")
@Produces(value="application/json;charset=UTF-8")
javax.ws.rs.core.Response restartService(@PathParam(value="host")
                                                         String host,
                                                         @PathParam(value="service")
                                                         String service)

Restarts a given service on a host, if the host supports the service

Parameters:: host - the host name; service - the service name
Returns:: a response

Interface IHost