org.apache.brooklyn.rest.api

Interface SensorApi

All Known Implementing Classes:

SensorResource

@Path(value="/applications/{application}/entities/{entity}/sensors")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface SensorApi

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	batchSensorRead(java.lang.String application, java.lang.String entityToken, java.lang.Boolean raw)
void	delete(java.lang.String application, java.lang.String entityToken, java.lang.String sensorName)
java.lang.Object	get(java.lang.String application, java.lang.String entityToken, java.lang.String sensorName, java.lang.Boolean raw)
java.lang.String	getPlain(java.lang.String application, java.lang.String entityToken, java.lang.String sensorName, java.lang.Boolean raw)
java.util.List<SensorSummary>	list(java.lang.String application, java.lang.String entityToken)
void	set(java.lang.String application, java.lang.String entityToken, java.lang.String sensorName, java.lang.Object newValue)
void	setFromMap(java.lang.String application, java.lang.String entityToken, java.util.Map newValues)

Method Detail

list

@GET
java.util.List<SensorSummary> list(@PathParam(value="application")
                                        java.lang.String application,
                                        @PathParam(value="entity")
                                        java.lang.String entityToken)

batchSensorRead

@GET
 @Path(value="/current-state")
java.util.Map<java.lang.String,java.lang.Object> batchSensorRead(@PathParam(value="application")
                                                                                                     java.lang.String application,
                                                                                                     @PathParam(value="entity")
                                                                                                     java.lang.String entityToken,
                                                                                                     @QueryParam(value="raw") @DefaultValue(value="false")
                                                                                                     java.lang.Boolean raw)

get

@GET
 @Path(value="/{sensor}")
 @Produces(value="application/json")
java.lang.Object get(@PathParam(value="application")
                                                                                         java.lang.String application,
                                                                                         @PathParam(value="entity")
                                                                                         java.lang.String entityToken,
                                                                                         @PathParam(value="sensor")
                                                                                         java.lang.String sensorName,
                                                                                         @QueryParam(value="raw") @DefaultValue(value="false")
                                                                                         java.lang.Boolean raw)

getPlain

@GET
 @Path(value="/{sensor}")
 @Produces(value="text/plain;qs=0.9")
java.lang.String getPlain(@PathParam(value="application")
                                                                                               java.lang.String application,
                                                                                               @PathParam(value="entity")
                                                                                               java.lang.String entityToken,
                                                                                               @PathParam(value="sensor")
                                                                                               java.lang.String sensorName,
                                                                                               @QueryParam(value="raw") @DefaultValue(value="false")
                                                                                               java.lang.Boolean raw)

setFromMap

@POST
void setFromMap(@PathParam(value="application")
                      java.lang.String application,
                      @PathParam(value="entity")
                      java.lang.String entityToken,
                      java.util.Map newValues)

set

@POST
 @Path(value="/{sensor}")
void set(@PathParam(value="application")
                                         java.lang.String application,
                                         @PathParam(value="entity")
                                         java.lang.String entityToken,
                                         @PathParam(value="sensor")
                                         java.lang.String sensorName,
                                         java.lang.Object newValue)

delete

@DELETE
 @Path(value="/{sensor}")
void delete(@PathParam(value="application")
                                              java.lang.String application,
                                              @PathParam(value="entity")
                                              java.lang.String entityToken,
                                              @PathParam(value="sensor")
                                              java.lang.String sensorName)