Package org.opennms.web.rest.v1

Class AcknowledgmentRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.AcknowledgmentRestService

@Component("acknowledgmentRestService")
@Path("acks")
public class AcknowledgmentRestService
extends OnmsRestService

ReST service for Acknowledgments of alarms/notifications.

Since:

1.8.1

Version:

$Id: $

Author:

David Hustace

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
AcknowledgmentRestService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	acknowledge(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.MultivaluedMap<String,String> formParams)	acknowledgeAlarm
OnmsAcknowledgment	getAcknowledgment(Integer acknowledgmentId)	getAcknowledgment
OnmsAcknowledgmentCollection	getAcks(javax.ws.rs.core.UriInfo uriInfo)	getAcks
String	getCount()	getCount

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

AcknowledgmentRestService

public AcknowledgmentRestService()

Method Detail

getAcknowledgment

@GET
@Produces({"application/xml","application/json","application/atom+xml"})
@Path("{id}")
@Transactional
public OnmsAcknowledgment getAcknowledgment(@PathParam("id")
                                            Integer acknowledgmentId)

getAcknowledgment

Parameters:

acknowledgmentId - a Integer object.

Returns:

a OnmsAcknowledgment object.

getCount

@GET
@Produces("text/plain")
@Path("count")
@Transactional
public String getCount()

getCount

Returns:

a String object.

getAcks

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

getAcks

Returns:

a OnmsAcknowledgmentCollection object.

acknowledge

@POST
@Consumes("application/x-www-form-urlencoded")
@Transactional
public javax.ws.rs.core.Response acknowledge(@Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             javax.ws.rs.core.MultivaluedMap<String,String> formParams)

acknowledgeAlarm

Parameters:

alarmId - a String object.

action - a String object.

Returns:

a Response object.