de.cinovo.cloudconductor.api.interfaces

Interface IAgent

@Path(value="/agent")
public interface IAgent

Rest API for usage with node agent. Copyright 2013 Cinovo AG

Author:

psigloch

Method Summary

Modifier and Type	Method and Description
Set<String>	getAliveAgents()
AgentOptions	heartBeat(String template, String host)
boolean	isServerAlive()
PackageStateChanges	notifyPackageState(String template, String host, PackageState rpmState)
ServiceStatesChanges	notifyServiceState(String template, String host, ServiceStates serviceState)

Method Detail

getAliveAgents

@GET
 @Path(value="/")
 @Produces(value="application/json;charset=UTF-8")
Set<String> getAliveAgents()

Returns:

list of living agents listed within the cloudconductor.

notifyPackageState

@PUT
 @Path(value="/{template}/{host}/package")
 @Consumes(value="application/json;charset=UTF-8")
 @Produces(value="application/json;charset=UTF-8")
PackageStateChanges notifyPackageState(@PathParam(value="template")
                                                                                                                                                                                             String template,
                                                                                                                                                                                             @PathParam(value="host")
                                                                                                                                                                                             String host,
                                                                                                                                                                                             PackageState rpmState)

Parameters:

template - the template name

host - the host name

rpmState - the rpm state

Returns:

list of instructions with changes to match the template

notifyServiceState

@PUT
 @Path(value="/{template}/{host}/service")
 @Consumes(value="application/json;charset=UTF-8")
 @Produces(value="application/json;charset=UTF-8")
ServiceStatesChanges notifyServiceState(@PathParam(value="template")
                                                                                                                                                                                              String template,
                                                                                                                                                                                              @PathParam(value="host")
                                                                                                                                                                                              String host,
                                                                                                                                                                                              ServiceStates serviceState)

Parameters:

template - the template name

host - the host name

serviceState - the service state

Returns:

list of instructions with changes to match the template

heartBeat

@GET
 @Path(value="/{template}/{host}/heartbeat")
 @Produces(value="application/json;charset=UTF-8")
AgentOptions heartBeat(@PathParam(value="template")
                                                                                                                            String template,
                                                                                                                            @PathParam(value="host")
                                                                                                                            String host)

Parameters:

template - the template name

host - the host name

Returns:

the current agent options

isServerAlive

@GET
 @Path(value="/ping")
 @Produces(value="application/json;charset=UTF-8")
boolean isServerAlive()

Returns:

check if server is alive