Package org.opennms.web.rest.v1

Class AlarmRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.AlarmRestServiceBase

org.opennms.web.rest.v1.AlarmRestService

@Component("alarmRestService")
@Path("alarms")
public class AlarmRestService
extends AlarmRestServiceBase

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.AlarmRestServiceBase

m_severityPattern

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

DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor	Description
AlarmRestService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getAlarm(javax.ws.rs.core.SecurityContext securityContext, String alarmId)	getAlarm
OnmsAlarmCollection	getAlarms(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo)	getAlarms
String	getCount(javax.ws.rs.core.SecurityContext securityContext)	getCount
javax.ws.rs.core.Response	updateAlarm(javax.ws.rs.core.SecurityContext securityContext, Integer alarmId, MultivaluedMapImpl formProperties)	updateAlarm
javax.ws.rs.core.Response	updateAlarms(javax.ws.rs.core.SecurityContext securityContext, MultivaluedMapImpl formProperties)	updateAlarms

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

getCriteria, getCriteriaBuilder, translateParameters

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

AlarmRestService

public AlarmRestService()

Method Detail

getAlarm

@GET
@Produces({"application/xml","application/json","application/atom+xml"})
@Path("{alarmId}")
@Transactional
public javax.ws.rs.core.Response getAlarm(@Context
                                          javax.ws.rs.core.SecurityContext securityContext,
                                          @PathParam("alarmId")
                                          String alarmId)

getAlarm

Parameters:

alarmId - a String object.

Returns:

a OnmsAlarm object.

getCount

@GET
@Produces("text/plain")
@Path("count")
@Transactional
public String getCount(@Context
                       javax.ws.rs.core.SecurityContext securityContext)

getCount

Returns:

a String object.

getAlarms

@GET
@Produces({"application/xml","application/json","application/atom+xml"})
@Transactional
public OnmsAlarmCollection getAlarms(@Context
                                     javax.ws.rs.core.SecurityContext securityContext,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo)

getAlarms

Returns:

a OnmsAlarmCollection object.

updateAlarm

@PUT
@Path("{alarmId}")
@Consumes("application/x-www-form-urlencoded")
@Transactional
public javax.ws.rs.core.Response updateAlarm(@Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @PathParam("alarmId")
                                             Integer alarmId,
                                             MultivaluedMapImpl formProperties)

updateAlarm

Parameters:

alarmId - a String object.

ack - a Boolean object.

updateAlarms

@PUT
@Transactional
@Consumes("application/x-www-form-urlencoded")
public javax.ws.rs.core.Response updateAlarms(@Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              MultivaluedMapImpl formProperties)

updateAlarms

Parameters:

formProperties - a MultivaluedMapImpl object.