org.onosproject.faultmanagement.web

Class AlarmsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.faultmanagement.web.AlarmsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="alarms")
public class AlarmsWebResource
extends org.onosproject.rest.AbstractWebResource

Alarms on devices or ONOS.

Constructor Summary

Constructors

Constructor and Description
AlarmsWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAlarm(String id) Get specified alarm.
javax.ws.rs.core.Response	getAlarms(boolean includeCleared, String devId) Get alarms.
javax.ws.rs.core.Response	update(String alarmIdPath, InputStream stream) Update book-keeping fields on the alarm.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok, setServiceDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmsWebResource

public AlarmsWebResource()

Method Detail

getAlarms

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAlarms(@DefaultValue(value="false") @QueryParam(value="includeCleared")
                                                                                     boolean includeCleared,
                                                                                     @DefaultValue(value="") @QueryParam(value="devId")
                                                                                     String devId)

Get alarms. Returns a list of alarms

Parameters:

includeCleared - (optional) include recently cleared alarms in response

devId - (optional) include only for specified device

Returns:

JSON encoded set of alarms

getAlarm

@GET
 @Path(value="{id}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAlarm(@PathParam(value="id")
                                                                                                         String id)

Get specified alarm. Returns details of the specified alarm.

Parameters:

id - ONOS allocated identifier

Returns:

JSON encoded alarm

update

@PUT
 @Path(value="{alarm_id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response update(@PathParam(value="alarm_id")
                                                                                                                                                  String alarmIdPath,
                                                                                                                                                  InputStream stream)

Update book-keeping fields on the alarm. Returns an up-to-date version of the alarm. Some of its fields may have been updated since the REST client last retrieved the alarm being updated.

Parameters:

alarmIdPath - alarm id path

stream - input JSON

Returns:

updated JSON encoded alarm