org.opennms.web.rest
Class OutageRestService

java.lang.Object
  org.opennms.web.rest.OnmsRestService
      org.opennms.web.rest.OutageRestService

@Component
@PerRequest
@Scope(value="prototype")
public class OutageRestService
extends OnmsRestService

TODO: Add functionality to getting outages by: nodelabel, nodeid, foreignsource, foreignsource+foreignid, ipaddress, etc. add filters for current, resolved, all

REST service to the OpenNMS Outage OnmsOutage data.

This service supports getting the list of outages or one specific outage by ID:

Example 1: Query List of outages.

curl -v -X GET -u admin:admin http://localhost:8980/opennms/rest/outages

Since:

1.8.1

Version:

$Id: $

Author:

Craig Miskell

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.web.rest.OnmsRestService

OnmsRestService.ComparisonOperation

Field Summary

Fields inherited from class org.opennms.web.rest.OnmsRestService

DEFAULT_LIMIT

Constructor Summary

OutageRestService()

Method Summary

OnmsOutageCollection	forNodeId(int nodeId) forNodeId
String	getCount() getCount
OnmsOutage	getOutage(String outageId) getOutage
OnmsOutageCollection	getOutages() getOutages

Methods inherited from class org.opennms.web.rest.OnmsRestService

addFiltersToCriteria, addOrdering, addOrdering, convertNameToPropertyName, getDistinctIdCriteria, log, setLimitOffset, setLimitOffset, setLimitOffset, setProperties, throwException

Methods inherited from class java.lang.Object

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

Constructor Detail

OutageRestService

public OutageRestService()

Method Detail

getOutage

@Transactional
public OnmsOutage getOutage(String outageId)

getOutage

Parameters:

outageId - a String object.

Returns:

a OnmsOutage object.

getCount

@Transactional
public String getCount()

getCount

Returns:

a String object.

getOutages

@Transactional
public OnmsOutageCollection getOutages()

getOutages

Returns:

a OnmsOutageCollection object.

forNodeId

@Transactional
public OnmsOutageCollection forNodeId(int nodeId)

forNodeId

Parameters:

nodeId - a int.

Returns:

a OnmsOutageCollection object.