service.tut.pori.apilta.alerts

Class AlertService

java.lang.Object

service.tut.pori.apilta.alerts.AlertService

@HTTPService(name="alerts")
public class AlertService
extends java.lang.Object

Service declaration for the alerts service

Constructor Summary

Constructors

Constructor and Description
AlertService()

Method Summary

Modifier and Type	Method and Description
core.tut.pori.http.Response	addAlert(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.LongParameter alertGroupId, core.tut.pori.http.parameters.InputStreamParameter xml)
core.tut.pori.http.Response	createFile(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.InputStreamParameter file)
core.tut.pori.http.Response	getAlerts(core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser, core.tut.pori.http.parameters.LongParameter alertGroupIdFilter, core.tut.pori.http.parameters.StringParameter alertTypeFilter, core.tut.pori.http.parameters.DateIntervalParameter createdFilter, core.tut.pori.http.parameters.DataGroups dataGroups, LocationParameter location, core.tut.pori.http.parameters.DoubleParameter range, core.tut.pori.http.parameters.Limits limits)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertService

public AlertService()

Method Detail

getAlerts

@HTTPServiceMethod(name="getAlerts",
                   acceptedMethods="GET")
public core.tut.pori.http.Response getAlerts(@HTTPAuthenticationParameter
                                                                                                                              core.tut.pori.http.parameters.AuthenticationParameter authenticatedUser,
                                                                                                                              @HTTPMethodParameter(name="alert_group_id",required=false)
                                                                                                                              core.tut.pori.http.parameters.LongParameter alertGroupIdFilter,
                                                                                                                              @HTTPMethodParameter(name="alert_type",required=false)
                                                                                                                              core.tut.pori.http.parameters.StringParameter alertTypeFilter,
                                                                                                                              @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="location",required=false)
                                                                                                                              LocationParameter location,
                                                                                                                              @HTTPMethodParameter(name="range",required=false)
                                                                                                                              core.tut.pori.http.parameters.DoubleParameter range,
                                                                                                                              @HTTPMethodParameter(name="limits",required=false)
                                                                                                                              core.tut.pori.http.parameters.Limits limits)

Parameters:

authenticatedUser -

alertGroupIdFilter -

alertTypeFilter -

createdFilter -

dataGroups -

location -

range -

limits -

Returns:

see AlertList

See Also:

ClientService.getAlerts(AuthenticationParameter, LongParameter, StringParameter, DateIntervalParameter, DataGroups, LocationParameter, DoubleParameter, Limits)

addAlert

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

Parameters:

authenticatedUser -

alertGroupId -

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

Returns:

response See AlertList

See Also:

ClientService.addAlert(AuthenticationParameter, LongParameter, InputStreamParameter)

createFile

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

Parameters:

authenticatedUser -

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

Returns:

FileDetailsList with identifier for the generated file

See Also:

ClientService.createFile(AuthenticationParameter, InputStreamParameter)