Package org.opennms.web.rest.v1

Class OnmsIpInterfaceResource

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.OnmsIpInterfaceResource

@Component("onmsIpInterfaceResource")
@Transactional
public class OnmsIpInterfaceResource
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	Description
OnmsIpInterfaceResource()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addIpInterface(javax.ws.rs.core.UriInfo uriInfo, String nodeCriteria, OnmsIpInterface ipInterface)	addIpInterface
javax.ws.rs.core.Response	deleteIpInterface(String nodeCriteria, String ipAddress)	deleteIpInterface
OnmsIpInterface	getIpInterface(String nodeCriteria, String ipAddress)	getIpInterface
OnmsIpInterfaceList	getIpInterfaces(javax.ws.rs.core.UriInfo uriInfo, String nodeCriteria)	getIpInterfaces
OnmsMonitoredServiceResource	getServices(javax.ws.rs.container.ResourceContext context)	getServices
javax.ws.rs.core.Response	updateIpInterface(String nodeCriteria, String ipAddress, MultivaluedMapImpl params)	updateIpInterface

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

OnmsIpInterfaceResource

public OnmsIpInterfaceResource()

Method Detail

getIpInterfaces

@GET
@Produces({"application/xml","application/json"})
public OnmsIpInterfaceList getIpInterfaces(@Context
                                           javax.ws.rs.core.UriInfo uriInfo,
                                           @PathParam("nodeCriteria")
                                           String nodeCriteria)

getIpInterfaces

Parameters:

nodeCriteria - a String object.

Returns:

a OnmsIpInterfaceList object.

getIpInterface

@GET
@Produces({"application/xml","application/json"})
@Path("{ipAddress}")
public OnmsIpInterface getIpInterface(@PathParam("nodeCriteria")
                                      String nodeCriteria,
                                      @PathParam("ipAddress")
                                      String ipAddress)

getIpInterface

Parameters:

nodeCriteria - a String object.

ipAddress - a String object.

Returns:

a OnmsIpInterface object.

addIpInterface

@POST
@Consumes("application/xml")
public javax.ws.rs.core.Response addIpInterface(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                @PathParam("nodeCriteria")
                                                String nodeCriteria,
                                                OnmsIpInterface ipInterface)

addIpInterface

Parameters:

nodeCriteria - a String object.

ipInterface - a OnmsIpInterface object.

Returns:

a Response object.

updateIpInterface

@PUT
@Consumes("application/x-www-form-urlencoded")
@Path("{ipAddress}")
public javax.ws.rs.core.Response updateIpInterface(@PathParam("nodeCriteria")
                                                   String nodeCriteria,
                                                   @PathParam("ipAddress")
                                                   String ipAddress,
                                                   MultivaluedMapImpl params)

updateIpInterface

Parameters:

nodeCriteria - a String object.

ipAddress - a String object.

params - a MultivaluedMapImpl object.

Returns:

a Response object.

deleteIpInterface

@DELETE
@Path("{ipAddress}")
public javax.ws.rs.core.Response deleteIpInterface(@PathParam("nodeCriteria")
                                                   String nodeCriteria,
                                                   @PathParam("ipAddress")
                                                   String ipAddress)

deleteIpInterface

Parameters:

nodeCriteria - a String object.

ipAddress - a String object.

Returns:

a Response object.

getServices

@Path("{ipAddress}/services")
public OnmsMonitoredServiceResource getServices(@Context
                                                javax.ws.rs.container.ResourceContext context)

getServices

Returns:

a org.opennms.web.rest.OnmsMonitoredServiceResource object.