service.tut.pori.apilta.sensors

Class SensorService

java.lang.Object

service.tut.pori.apilta.sensors.SensorService

@HTTPService(name="sensors")
public class SensorService
extends java.lang.Object

Service declaration for the sensor service

Constructor Summary

Constructors

Constructor and Description
SensorService()

Method Summary

Modifier and Type	Method and Description
core.tut.pori.http.Response	createFile(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.LongParameter backendId, core.tut.pori.http.parameters.InputStreamParameter file) Implementation of create file
core.tut.pori.http.Response	createTask(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.InputStreamParameter xml) Implementation of create task
core.tut.pori.http.Response	getMeasurements(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.StringParameter taskId, core.tut.pori.http.parameters.LongParameter backendIdFilter, core.tut.pori.http.parameters.DateIntervalParameter createdFilter, core.tut.pori.http.parameters.DataGroups dataGroups, core.tut.pori.http.parameters.Limits limits, core.tut.pori.http.parameters.StringParameter measurementIdFilter)
core.tut.pori.http.Response	modifyTask(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.InputStreamParameter xml) Implementation of modify task
core.tut.pori.http.Response	queryTaskDetails(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.LongParameter backendId, core.tut.pori.http.parameters.StringParameter taskId, core.tut.pori.http.parameters.DataGroups dataGroups, core.tut.pori.http.parameters.Limits limits)
void	taskFinished(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.InputStreamParameter xml)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SensorService

public SensorService()

Method Detail

taskFinished

@HTTPServiceMethod(name="taskFinished",
                   acceptedMethods="POST")
public void taskFinished(@HTTPAuthenticationParameter
                                                                                                              core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser,
                                                                                                              @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                              core.tut.pori.http.parameters.InputStreamParameter xml)

Parameters:

authenticatedUser -

xml - Only the result data should be in the body. See SensorTask

queryTaskDetails

@HTTPServiceMethod(name="queryTaskDetails",
                   acceptedMethods="GET")
public core.tut.pori.http.Response queryTaskDetails(@HTTPAuthenticationParameter
                                                                                                                                            core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser,
                                                                                                                                            @HTTPMethodParameter(name="backend_id")
                                                                                                                                            core.tut.pori.http.parameters.LongParameter backendId,
                                                                                                                                            @HTTPMethodParameter(name="task_id")
                                                                                                                                            core.tut.pori.http.parameters.StringParameter taskId,
                                                                                                                                            @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                                            core.tut.pori.http.parameters.DataGroups dataGroups,
                                                                                                                                            @HTTPMethodParameter(name="limits",required=false)
                                                                                                                                            core.tut.pori.http.parameters.Limits limits)

Parameters:

authenticatedUser -

taskId -

backendId -

dataGroups -

limits - paging limits

Returns:

response See SensorTask

createTask

@HTTPServiceMethod(name="createTask",
                   acceptedMethods="POST")
public core.tut.pori.http.Response createTask(@HTTPAuthenticationParameter
                                                                                                                                 core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser,
                                                                                                                                 @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                                                 core.tut.pori.http.parameters.InputStreamParameter xml)

Implementation of create task

Parameters:

authenticatedUser -

xml - Only the workload data should be in the body. See SensorTask

Returns:

TaskList with identifier for the generated task

modifyTask

@HTTPServiceMethod(name="modifyTask",
                   acceptedMethods="POST")
public core.tut.pori.http.Response modifyTask(@HTTPAuthenticationParameter
                                                                                                                                 core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser,
                                                                                                                                 @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                                                 core.tut.pori.http.parameters.InputStreamParameter xml)

Implementation of modify task

Parameters:

authenticatedUser -

xml - Only the workload data should be in the body. See SensorTask

Returns:

TaskList with identifier for the generated task

createFile

@HTTPServiceMethod(name="createFile",
                   acceptedMethods="POST")
public core.tut.pori.http.Response createFile(@HTTPAuthenticationParameter
                                                                                                                                 core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser,
                                                                                                                                 @HTTPMethodParameter(name="backend_id")
                                                                                                                                 core.tut.pori.http.parameters.LongParameter backendId,
                                                                                                                                 @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                                                 core.tut.pori.http.parameters.InputStreamParameter file)

Implementation of create file

Parameters:

authenticatedUser -

backendId -

file - only the file contents should be in the body.

Returns:

FileDetailsList with identifier for the generated file

getMeasurements

@HTTPServiceMethod(name="getMeasurements",
                   acceptedMethods="GET")
public core.tut.pori.http.Response getMeasurements(@HTTPAuthenticationParameter
                                                                                                                                          core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser,
                                                                                                                                          @HTTPMethodParameter(name="task_id")
                                                                                                                                          core.tut.pori.http.parameters.StringParameter taskId,
                                                                                                                                          @HTTPMethodParameter(name="backend_id",required=false)
                                                                                                                                          core.tut.pori.http.parameters.LongParameter backendIdFilter,
                                                                                                                                          @HTTPMethodParameter(name="created",required=false)
                                                                                                                                          core.tut.pori.http.parameters.DateIntervalParameter createdFilter,
                                                                                                                                          @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                                          core.tut.pori.http.parameters.DataGroups dataGroups,
                                                                                                                                          @HTTPMethodParameter(name="limits",required=false)
                                                                                                                                          core.tut.pori.http.parameters.Limits limits,
                                                                                                                                          @HTTPMethodParameter(name="measurement_id",required=false)
                                                                                                                                          core.tut.pori.http.parameters.StringParameter measurementIdFilter)

Parameters:

authenticatedUser -

taskId -

backendIdFilter -

createdFilter -

dataGroups - for valid data groups see SensorsCore.getMeasurements(core.tut.pori.users.UserIdentity, long[], java.util.Set, DataGroups, Limits, java.util.List, java.util.List)

limits -

measurementIdFilter -

Returns:

see MeasurementList