org.opennms.netmgt.ncs.rest

Class NCSRestService

java.lang.Object

org.opennms.netmgt.ncs.rest.NCSRestService

@Component(value="ncsRestService")
 @Path(value="NCS")
 @Transactional
public class NCSRestService
extends Object

Basic Web Service using REST for NCS Components

Author:

Matt Brozowski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NCSRestService.ComponentList

Constructor Summary

Constructors

Constructor and Description
NCSRestService()

Method Summary

Modifier and Type	Method and Description
NCSComponent	addComponent(boolean deleteOrphans, String type, String foreignSource, String foreignId, NCSComponent subComponent) getNodes
javax.ws.rs.core.Response	addComponents(boolean deleteOrphans, NCSComponent component)
void	afterPropertiesSet()
javax.ws.rs.core.Response	deleteComponent(boolean deleteOrphans, String type, String foreignSource, String foreignId)
NCSComponent	getComponent(String type, String foreignSource, String foreignId) getNodes
NCSRestService.ComponentList	getComponentsByAttributes()
protected void	readLock()
protected void	readUnlock()
protected void	writeLock()
protected void	writeUnlock()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NCSRestService

public NCSRestService()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws RuntimeException

Throws:

RuntimeException

getComponent

@GET
 @Produces(value={"application/xml","application/json"})
 @Path(value="{type}/{foreignSource}:{foreignId}")
public NCSComponent getComponent(@PathParam(value="type")
                                                                                                                                                  String type,
                                                                                                                                                  @PathParam(value="foreignSource")
                                                                                                                                                  String foreignSource,
                                                                                                                                                  @PathParam(value="foreignId")
                                                                                                                                                  String foreignId)

getNodes

Returns:

a OnmsNodeList object.

getComponentsByAttributes

@GET
 @Path(value="attributes")
public NCSRestService.ComponentList getComponentsByAttributes()

addComponents

@POST
 @Consumes(value="application/xml")
public javax.ws.rs.core.Response addComponents(@QueryParam(value="deleteOrphans")
                                                                                         boolean deleteOrphans,
                                                                                         NCSComponent component)

addComponent

@POST
 @Produces(value={"application/xml","application/json"})
 @Path(value="{type}/{foreignSource}:{foreignId}")
public NCSComponent addComponent(@QueryParam(value="deleteOrphans")
                                                                                                                                                   boolean deleteOrphans,
                                                                                                                                                   @PathParam(value="type")
                                                                                                                                                   String type,
                                                                                                                                                   @PathParam(value="foreignSource")
                                                                                                                                                   String foreignSource,
                                                                                                                                                   @PathParam(value="foreignId")
                                                                                                                                                   String foreignId,
                                                                                                                                                   NCSComponent subComponent)

getNodes

Returns:

a OnmsNodeList object.

deleteComponent

@DELETE
 @Path(value="{type}/{foreignSource}:{foreignId}")
public javax.ws.rs.core.Response deleteComponent(@QueryParam(value="deleteOrphans")
                                                                                                            boolean deleteOrphans,
                                                                                                            @PathParam(value="type")
                                                                                                            String type,
                                                                                                            @PathParam(value="foreignSource")
                                                                                                            String foreignSource,
                                                                                                            @PathParam(value="foreignId")
                                                                                                            String foreignId)

readLock

protected void readLock()

readUnlock

protected void readUnlock()

writeLock

protected void writeLock()

writeUnlock

protected void writeUnlock()