Package org.opennms.web.rest.v1

Class CategoryRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.CategoryRestService

@Component("categoryRestService")
@Path("categories")
@Transactional
public class CategoryRestService
extends OnmsRestService

CategoryRestService 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	Description
CategoryRestService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addCategoryToGroup(javax.ws.rs.container.ResourceContext context, String groupName, String categoryName)
javax.ws.rs.core.Response	addCategoryToNode(javax.ws.rs.container.ResourceContext context, javax.ws.rs.core.UriInfo uriInfo, String nodeCriteria, String categoryName)
javax.ws.rs.core.Response	createCategory(javax.ws.rs.core.UriInfo uriInfo, OnmsCategory category)
javax.ws.rs.core.Response	deleteCategory(String categoryName)
OnmsCategoryCollection	getCategoriesForNode(javax.ws.rs.container.ResourceContext context, String nodeCriteria)
OnmsCategory	getCategory(String categoryName)
OnmsCategory	getCategoryForNode(javax.ws.rs.container.ResourceContext context, String nodeCriteria, String categoryName)
OnmsCategoryCollection	listCategories()
OnmsCategoryCollection	listCategoriesForGroup(javax.ws.rs.container.ResourceContext context, String groupName)
javax.ws.rs.core.Response	removeCategoryFromGroup(javax.ws.rs.container.ResourceContext context, String groupName, String categoryName)
javax.ws.rs.core.Response	removeCategoryFromNode(javax.ws.rs.container.ResourceContext context, String nodeCriteria, String categoryName)
javax.ws.rs.core.Response	updateCategory(String categoryName, MultivaluedMapImpl params)

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

CategoryRestService

public CategoryRestService()

Method Detail

getCategoriesForNode

@GET
@Produces({"application/xml","application/json"})
@Path("/nodes/{nodeCriteria}")
public OnmsCategoryCollection getCategoriesForNode(@Context
                                                   javax.ws.rs.container.ResourceContext context,
                                                   @PathParam("nodeCriteria")
                                                   String nodeCriteria)

getCategoryForNode

@GET
@Produces({"application/xml","application/json"})
@Path("{categoryName}/nodes/{nodeCriteria}")
public OnmsCategory getCategoryForNode(@Context
                                       javax.ws.rs.container.ResourceContext context,
                                       @PathParam("nodeCriteria")
                                       String nodeCriteria,
                                       @PathParam("categoryName")
                                       String categoryName)

addCategoryToNode

@PUT
@Consumes("application/xml")
@Path("{categoryName}/nodes/{nodeCriteria}/")
public javax.ws.rs.core.Response addCategoryToNode(@Context
                                                   javax.ws.rs.container.ResourceContext context,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @PathParam("nodeCriteria")
                                                   String nodeCriteria,
                                                   @PathParam("categoryName")
                                                   String categoryName)

updateCategory

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

removeCategoryFromNode

@DELETE
@Path("/{categoryName}/nodes/{nodeCriteria}/")
public javax.ws.rs.core.Response removeCategoryFromNode(@Context
                                                        javax.ws.rs.container.ResourceContext context,
                                                        @PathParam("nodeCriteria")
                                                        String nodeCriteria,
                                                        @PathParam("categoryName")
                                                        String categoryName)

getCategory

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

createCategory

@POST
@Path("/")
public javax.ws.rs.core.Response createCategory(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                OnmsCategory category)

listCategories

@GET
@Path("/")
@Produces({"application/xml","application/json"})
public OnmsCategoryCollection listCategories()

deleteCategory

@DELETE
@Path("/{categoryName}")
public javax.ws.rs.core.Response deleteCategory(@PathParam("categoryName")
                                                String categoryName)

addCategoryToGroup

@PUT
@Path("/{categoryName}/groups/{groupName}")
public javax.ws.rs.core.Response addCategoryToGroup(@Context
                                                    javax.ws.rs.container.ResourceContext context,
                                                    @PathParam("groupName")
                                                    String groupName,
                                                    @PathParam("categoryName")
                                                    String categoryName)

removeCategoryFromGroup

@DELETE
@Path("/{categoryName}/groups/{groupName}")
public javax.ws.rs.core.Response removeCategoryFromGroup(@Context
                                                         javax.ws.rs.container.ResourceContext context,
                                                         @PathParam("groupName")
                                                         String groupName,
                                                         @PathParam("categoryName")
                                                         String categoryName)

listCategoriesForGroup

@GET
@Path("/groups/{groupName}")
@Produces({"application/xml","application/json"})
public OnmsCategoryCollection listCategoriesForGroup(@Context
                                                     javax.ws.rs.container.ResourceContext context,
                                                     @PathParam("groupName")
                                                     String groupName)