Package org.opennms.web.rest.v1

Class NodeRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.NodeRestService

@Component("nodeRestService")
@Path("nodes")
@Transactional
public class NodeRestService
extends OnmsRestService

Basic Web Service using REST for OnmsNode entity

Since:

1.8.1

Version:

$Id: $

Author:

Alejandro Galue

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

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addCategoryToNode(javax.ws.rs.core.UriInfo uriInfo, String nodeCriteria, String categoryName)
javax.ws.rs.core.Response	addCategoryToNode(javax.ws.rs.core.UriInfo uriInfo, String nodeCriteria, OnmsCategory category)
javax.ws.rs.core.Response	addNode(javax.ws.rs.core.UriInfo uriInfo, OnmsNode node)	addNode
javax.ws.rs.core.Response	deleteNode(String nodeCriteria)	deleteNode
AssetRecordResource	getAssetRecordResource(javax.ws.rs.container.ResourceContext context)	getAssetRecordResource
OnmsCategoryCollection	getCategoriesForNode(String nodeCriteria)
OnmsCategory	getCategoryForNode(String nodeCriteria, String categoryName)
HardwareInventoryResource	getHardwareInventoryResource(javax.ws.rs.container.ResourceContext context)	getHardwareInventoryResource
OnmsIpInterfaceResource	getIpInterfaceResource(javax.ws.rs.container.ResourceContext context)	getIpInterfaceResource
OnmsNode	getNode(String nodeCriteria)	getNode
OnmsNodeList	getNodes(javax.ws.rs.core.UriInfo uriInfo)	getNodes
OnmsSnmpInterfaceResource	getSnmpInterfaceResource(javax.ws.rs.container.ResourceContext context)	getSnmpInterfaceResource
javax.ws.rs.core.Response	removeCategoryFromNode(String nodeCriteria, String categoryName)
javax.ws.rs.core.Response	rescanNode(String nodeCriteria)	rescanNode
javax.ws.rs.core.Response	updateCategoryForNode(String nodeCriteria, String categoryName, MultivaluedMapImpl params)
javax.ws.rs.core.Response	updateNode(String nodeCriteria, MultivaluedMapImpl params)	updateNode

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

NodeRestService

public NodeRestService()

Method Detail

getNodes

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

getNodes

Returns:

a OnmsNodeList object.

getNode

@GET
@Produces({"application/xml","application/json","application/atom+xml"})
@Path("{nodeCriteria}")
public OnmsNode getNode(@PathParam("nodeCriteria")
                        String nodeCriteria)

getNode

Parameters:

nodeCriteria - a String object.

Returns:

a OnmsNode object.

rescanNode

@PUT
@Consumes("application/x-www-form-urlencoded")
@Path("{nodeCriteria}/rescan")
public javax.ws.rs.core.Response rescanNode(@PathParam("nodeCriteria")
                                            String nodeCriteria)

rescanNode

Parameters:

nodeCriteria - a String object.

Returns:

a Response object.

addNode

@POST
@Consumes("application/xml")
public javax.ws.rs.core.Response addNode(@Context
                                         javax.ws.rs.core.UriInfo uriInfo,
                                         OnmsNode node)

addNode

Parameters:

node - a OnmsNode object.

Returns:

a Response object.

updateNode

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

updateNode

Parameters:

nodeCriteria - a String object.

params - a MultivaluedMapImpl object.

Returns:

a Response object.

deleteNode

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

deleteNode

Parameters:

nodeCriteria - a String object.

Returns:

a Response object.

getIpInterfaceResource

@Path("{nodeCriteria}/ipinterfaces")
public OnmsIpInterfaceResource getIpInterfaceResource(@Context
                                                      javax.ws.rs.container.ResourceContext context)

getIpInterfaceResource

Returns:

a org.opennms.web.rest.OnmsIpInterfaceResource object.

getSnmpInterfaceResource

@Path("{nodeCriteria}/snmpinterfaces")
public OnmsSnmpInterfaceResource getSnmpInterfaceResource(@Context
                                                          javax.ws.rs.container.ResourceContext context)

getSnmpInterfaceResource

Returns:

a org.opennms.web.rest.OnmsSnmpInterfaceResource object.

getAssetRecordResource

@Path("{nodeCriteria}/assetRecord")
public AssetRecordResource getAssetRecordResource(@Context
                                                  javax.ws.rs.container.ResourceContext context)

getAssetRecordResource

Returns:

a org.opennms.web.rest.AssetRecordResource object.

getHardwareInventoryResource

@Path("{nodeCriteria}/hardwareInventory")
public HardwareInventoryResource getHardwareInventoryResource(@Context
                                                              javax.ws.rs.container.ResourceContext context)

getHardwareInventoryResource

Returns:

a org.opennms.web.rest.HardwareInventoryResource object.

getCategoriesForNode

@GET
@Path("/{nodeCriteria}/categories")
@Produces({"application/xml","application/json"})
public OnmsCategoryCollection getCategoriesForNode(@PathParam("nodeCriteria")
                                                   String nodeCriteria)

getCategoryForNode

@GET
@Produces({"application/xml","application/json"})
@Path("/{nodeCriteria}/categories/{categoryName}")
public OnmsCategory getCategoryForNode(@PathParam("nodeCriteria")
                                       String nodeCriteria,
                                       @PathParam("categoryName")
                                       String categoryName)

addCategoryToNode

@POST
@Consumes("application/xml")
@Path("/{nodeCriteria}/categories")
public javax.ws.rs.core.Response addCategoryToNode(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @PathParam("nodeCriteria")
                                                   String nodeCriteria,
                                                   OnmsCategory category)

addCategoryToNode

@POST
@Path("/{nodeCriteria}/categories/{categoryName}")
public javax.ws.rs.core.Response addCategoryToNode(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @PathParam("nodeCriteria")
                                                   String nodeCriteria,
                                                   @PathParam("categoryName")
                                                   String categoryName)

updateCategoryForNode

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

removeCategoryFromNode

@DELETE
@Path("/{nodeCriteria}/categories/{categoryName}")
public javax.ws.rs.core.Response removeCategoryFromNode(@PathParam("nodeCriteria")
                                                        String nodeCriteria,
                                                        @PathParam("categoryName")
                                                        String categoryName)