org.opennms.web.rest.v1

Class EventRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.EventRestService

@Component(value="eventRestService")
 @Path(value="events")
public class EventRestService
extends OnmsRestService

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 and Description
EventRestService()

Method Summary

Modifier and Type	Method and Description
String	getCount() returns a plaintext string being the number of events
OnmsEvent	getEvent(Integer eventId) getEvent
OnmsEventCollection	getEvents(javax.ws.rs.core.UriInfo uriInfo) Returns all the events which match the filter/query in the query parameters
OnmsEventCollection	getEventsBetween(javax.ws.rs.core.UriInfo uriInfo) Returns all the events which match the filter/query in the query parameters
javax.ws.rs.core.Response	updateEvent(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, String eventId, Boolean ack) Updates the event with id "eventid" If the "ack" parameter is "true", then acks the events as the current logged in user, otherwise unacks the events
javax.ws.rs.core.Response	updateEvents(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, MultivaluedMapImpl formProperties) Updates all the events that match any filter/query supplied in the form.

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

EventRestService

public EventRestService()

Method Detail

getEvent

@GET
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Path(value="{eventId}")
 @Transactional
public OnmsEvent getEvent(@PathParam(value="eventId")
                                                                                                                                                         Integer eventId)

getEvent

Parameters:

eventId - a String object.

Returns:

a OnmsEvent object.

getCount

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

returns a plaintext string being the number of events

Returns:

a String object.

getEvents

@GET
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Transactional
public OnmsEventCollection getEvents(@Context
                                                                                                                                          javax.ws.rs.core.UriInfo uriInfo)
                                                                                                                                   throws ParseException

Returns all the events which match the filter/query in the query parameters

Returns:

Collection of OnmsEventCollection (ready to be XML-ified)

Throws:

ParseException - if any.

getEventsBetween

@GET
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Path(value="between")
 @Transactional
public OnmsEventCollection getEventsBetween(@Context
                                                                                                                                                                         javax.ws.rs.core.UriInfo uriInfo)
                                                                                                                                                                  throws ParseException

Returns all the events which match the filter/query in the query parameters

Returns:

Collection of OnmsEventCollection (ready to be XML-ified)

Throws:

ParseException - if any.

updateEvent

@PUT
 @Path(value="{eventId}")
 @Consumes(value="application/x-www-form-urlencoded")
 @Transactional
public javax.ws.rs.core.Response updateEvent(@Context
                                                                                                                                                  javax.ws.rs.core.SecurityContext securityContext,
                                                                                                                                                  @Context
                                                                                                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                                  @PathParam(value="eventId")
                                                                                                                                                  String eventId,
                                                                                                                                                  @FormParam(value="ack")
                                                                                                                                                  Boolean ack)

Updates the event with id "eventid" If the "ack" parameter is "true", then acks the events as the current logged in user, otherwise unacks the events

Parameters:

eventId - a String object.

ack - a Boolean object.

updateEvents

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

Updates all the events that match any filter/query supplied in the form. If the "ack" parameter is "true", then acks the events as the current logged in user, otherwise unacks the events

Parameters:

formProperties - Map of the parameters passed in by form encoding