Package org.opennms.web.rest.v1

Class AvailabilityRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.AvailabilityRestService

@Component("availabilityRestService")
@Path("availability")
@Transactional
@Produces({"application/xml","application/json","application/atom+xml"})
public class AvailabilityRestService
extends OnmsRestService

Basic Web Service using REST for Availability/RTC information.

Since:

15.0.2

Author:

Benjamin Reed

Nested Class Summary

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

OnmsRestService.ComparisonOperation

Field Summary

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

DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor	Description
AvailabilityRestService()

Method Summary

Modifier and Type	Method	Description
Category	getCategory(String categoryName)
AvailabilityNode	getCategoryNode(String categoryName, Long nodeId)
NodeList	getCategoryNodes(String categoryName)
AvailabilityNode	getNode(Integer nodeId)
org.opennms.web.rest.v1.AvailabilityRestService.AvailabilityData	getNodeAvailability()

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

applyQueryFilters, applyQueryFilters, getBadRequestResponse, getBeanWrapperForClass, getException, getException, getNumericValue, getRedirectUri, readLock, readUnlock, removeParameter, removeParameter, setProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailabilityRestService

public AvailabilityRestService()

Method Detail

getNodeAvailability

@GET
public org.opennms.web.rest.v1.AvailabilityRestService.AvailabilityData getNodeAvailability()

getCategory

@GET
@Path("/categories/{category}")
public Category getCategory(@PathParam("category")
                            String categoryName)

getCategoryNodes

@GET
@Path("/categories/{category}/nodes")
public NodeList getCategoryNodes(@PathParam("category")
                                 String categoryName)

getCategoryNode

@GET
@Path("/categories/{category}/nodes/{nodeId}")
public AvailabilityNode getCategoryNode(@PathParam("category")
                                        String categoryName,
                                        @PathParam("nodeId")
                                        Long nodeId)

getNode

@GET
@Path("/nodes/{nodeId}")
public AvailabilityNode getNode(@PathParam("nodeId")
                                Integer nodeId)