Package org.opennms.web.rest.v1

Class HardwareInventoryResource

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.HardwareInventoryResource

Direct Known Subclasses:

NodeHardwareInventoryRestService

@Component("hardwareInventoryResource")
@Path("hardwareInventory")
@Transactional
public class HardwareInventoryResource
extends OnmsRestService

The Class HardwareInventoryResource. Retrieve the root entity (all hardware inventory) GET /nodes/{nodeId}/hardwareInventory Override the root entity (all hardware inventory) POST /nodes/{nodeId}/hardwareInventory Retrieve a specific entity GET /nodes/{nodeId}/hardwareInventory/{entPhysicalIndex} Delete a specific entity DELETE /nodes/{nodeId}/hardwareInventory/{entPhysicalIndex} Modify an existing entity PUT /nodes/{nodeId}/hardwareInventory/{entPhysicalIndex} Add a child entity POST /nodes/{nodeId}/hardwareInventory/{entPhysicalIndex}

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

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addOrReplaceChild(String nodeCriteria, Integer parentEntPhysicalIndex, OnmsHwEntity child)	Adds or replaces a child entity.
javax.ws.rs.core.Response	deleteHwEntity(String nodeCriteria, Integer entPhysicalIndex)	Delete hardware entity.
OnmsHwEntity	getHardwareInventory(String nodeCriteria)	Gets the hardware inventory.
OnmsHwEntity	getHwEntityByIndex(String nodeCriteria, Integer entPhysicalIndex)	Gets the hardware entity by index.
javax.ws.rs.core.Response	setHardwareInventory(String nodeCriteria, OnmsHwEntity entity)	Sets the hardware inventory (root object)
javax.ws.rs.core.Response	updateHwEntity(String nodeCriteria, Integer entPhysicalIndex, MultivaluedMapImpl params)	Update hardware entity.

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

HardwareInventoryResource

public HardwareInventoryResource()

Method Detail

getHardwareInventory

@GET
@Produces({"application/xml","application/json"})
public OnmsHwEntity getHardwareInventory(@PathParam("nodeCriteria")
                                         String nodeCriteria)

Gets the hardware inventory.

Parameters:

nodeCriteria - the node criteria

Returns:

the root hardware entity

getHwEntityByIndex

@GET
@Path("{entPhysicalIndex}")
@Produces({"application/xml","application/json"})
public OnmsHwEntity getHwEntityByIndex(@PathParam("nodeCriteria")
                                       String nodeCriteria,
                                       @PathParam("entPhysicalIndex")
                                       Integer entPhysicalIndex)

Gets the hardware entity by index.

Parameters:

nodeCriteria - the node criteria

entPhysicalIndex - the entity physical index

Returns:

the hardware entity

setHardwareInventory

@POST
@Consumes({"application/xml","application/json"})
public javax.ws.rs.core.Response setHardwareInventory(@PathParam("nodeCriteria")
                                                      String nodeCriteria,
                                                      OnmsHwEntity entity)

Sets the hardware inventory (root object)

Parameters:

nodeCriteria - the node criteria

entity - the root entity object

Returns:

the response

addOrReplaceChild

@POST
@Path("{parentEntPhysicalIndex}")
@Consumes({"application/xml","application/json"})
public javax.ws.rs.core.Response addOrReplaceChild(@PathParam("nodeCriteria")
                                                   String nodeCriteria,
                                                   @PathParam("parentEntPhysicalIndex")
                                                   Integer parentEntPhysicalIndex,
                                                   OnmsHwEntity child)

Adds or replaces a child entity.

Parameters:

nodeCriteria - the node criteria

parentEntPhysicalIndex - the parent entity physical index

child - the child

Returns:

the response

updateHwEntity

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

Update hardware entity.

Parameters:

nodeCriteria - the node criteria

entPhysicalIndex - the entity physical index

params - the parameters

Returns:

the response

deleteHwEntity

@DELETE
@Path("{entPhysicalIndex}")
public javax.ws.rs.core.Response deleteHwEntity(@PathParam("nodeCriteria")
                                                String nodeCriteria,
                                                @PathParam("entPhysicalIndex")
                                                Integer entPhysicalIndex)

Delete hardware entity.

Parameters:

nodeCriteria - the node criteria

entPhysicalIndex - the entity physical index

Returns:

the response