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

public class AlarmsWebResource
extends org.onosproject.rest.AbstractWebResource

Alarms on devices or ONOS.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALARM_NOT_FOUND

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) Get all 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

Field Detail

ALARM_NOT_FOUND

public static final String ALARM_NOT_FOUND

See Also:

Constant Field Values

Constructor Detail

AlarmsWebResource

public AlarmsWebResource()

Method Detail

getAlarms

public javax.ws.rs.core.Response getAlarms(boolean includeCleared)

Get all alarms. Returns a list of all alarms across all devices.

Parameters:

includeCleared - include recently cleared alarms in response

Returns:

JSON encoded set of alarms

getAlarm

public javax.ws.rs.core.Response getAlarm(String id)

Get specified alarm. Returns details of the specified alarm.

Parameters:

id - ONOS allocated identifier

Returns:

JSON encoded alarm

update

public javax.ws.rs.core.Response update(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