org.opennms.web.rest.v1

Class OnmsMonitoredServiceResource

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.OnmsMonitoredServiceResource

@Component(value="onmsMonitoredServiceResource")
 @Transactional
public class OnmsMonitoredServiceResource
extends OnmsRestService

OnmsMonitoredServiceResource class.

Since:

1.8.1

Version:

$Id: $

Author:

ranger

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addService(javax.ws.rs.core.UriInfo uriInfo, String nodeCriteria, String ipAddress, OnmsMonitoredService service) addService
javax.ws.rs.core.Response	deleteService(String nodeCriteria, String ipAddress, String serviceName) deleteService
OnmsMonitoredService	getService(String nodeCriteria, String ipAddress, String service) getService
OnmsMonitoredServiceList	getServices(String nodeCriteria, String ipAddress) getServices
javax.ws.rs.core.Response	updateService(javax.ws.rs.core.UriInfo uriInfo, String nodeCriteria, String ipAddress, String serviceName, MultivaluedMapImpl params) updateService

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

OnmsMonitoredServiceResource

public OnmsMonitoredServiceResource()

Method Detail

getServices

@GET
 @Produces(value={"application/xml","application/json"})
public OnmsMonitoredServiceList getServices(@PathParam(value="nodeCriteria")
                                                                                                          String nodeCriteria,
                                                                                                          @PathParam(value="ipAddress")
                                                                                                          String ipAddress)

getServices

Parameters:

nodeCriteria - a String object.

ipAddress - a String object.

Returns:

a OnmsMonitoredServiceList object.

getService

@GET
 @Produces(value={"application/xml","application/json"})
 @Path(value="{service}")
public OnmsMonitoredService getService(@PathParam(value="nodeCriteria")
                                                                                                                               String nodeCriteria,
                                                                                                                               @PathParam(value="ipAddress")
                                                                                                                               String ipAddress,
                                                                                                                               @PathParam(value="service")
                                                                                                                               String service)

getService

Parameters:

nodeCriteria - a String object.

ipAddress - a String object.

service - a String object.

Returns:

a OnmsMonitoredService object.

addService

@POST
 @Consumes(value="application/xml")
public javax.ws.rs.core.Response addService(@Context
                                                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                                                      @PathParam(value="nodeCriteria")
                                                                                      String nodeCriteria,
                                                                                      @PathParam(value="ipAddress")
                                                                                      String ipAddress,
                                                                                      OnmsMonitoredService service)

addService

Parameters:

nodeCriteria - a String object.

ipAddress - a String object.

service - a OnmsMonitoredService object.

Returns:

a Response object.

updateService

@PUT
 @Consumes(value="application/x-www-form-urlencoded")
 @Path(value="{service}")
public javax.ws.rs.core.Response updateService(@Context
                                                                                                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                    @PathParam(value="nodeCriteria")
                                                                                                                                    String nodeCriteria,
                                                                                                                                    @PathParam(value="ipAddress")
                                                                                                                                    String ipAddress,
                                                                                                                                    @PathParam(value="service")
                                                                                                                                    String serviceName,
                                                                                                                                    MultivaluedMapImpl params)

updateService

Parameters:

nodeCriteria - a String object.

ipAddress - a String object.

serviceName - a String object.

params - a MultivaluedMapImpl object.

Returns:

a Response object.

deleteService

@DELETE
 @Path(value="{service}")
public javax.ws.rs.core.Response deleteService(@PathParam(value="nodeCriteria")
                                                                                 String nodeCriteria,
                                                                                 @PathParam(value="ipAddress")
                                                                                 String ipAddress,
                                                                                 @PathParam(value="service")
                                                                                 String serviceName)

deleteService

Parameters:

nodeCriteria - a String object.

ipAddress - a String object.

serviceName - a String object.

Returns:

a Response object.