org.opennms.web.rest.v1

Class GroupRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.GroupRestService

@Component(value="groupRestService")
 @Path(value="groups")
 @Transactional
public class GroupRestService
extends OnmsRestService

Basic Web Service using REST for OnmsGroup entity

Since:

1.9.93

Author:

Benjamin Reed

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 and Description
GroupRestService()

Method Summary

Modifier and Type	Method and Description
OnmsCategory	addCategory(String groupName, String categoryName)
javax.ws.rs.core.Response	addGroup(javax.ws.rs.core.UriInfo uriInfo, OnmsGroup group)
javax.ws.rs.core.Response	addUser(javax.ws.rs.core.UriInfo uriInfo, String groupName, String userName)
javax.ws.rs.core.Response	deleteGroup(String groupName)
OnmsCategory	getCategoryForGroup(String groupName, String categoryName)
OnmsGroup	getGroup(String groupName)
OnmsGroupList	getGroups()
protected OnmsGroup	getOnmsGroup(String groupName)
OnmsUser	getUser(String groupName, String userName)
OnmsCategoryCollection	listCategories(String groupName)
OnmsUserList	listUsersOfGroup(String groupName)
javax.ws.rs.core.Response	removeCategory(String groupName, String categoryName)
javax.ws.rs.core.Response	removeUser(String groupName, String userName)
javax.ws.rs.core.Response	updateGroup(javax.ws.rs.core.UriInfo uriInfo, String groupName, 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

GroupRestService

public GroupRestService()

Method Detail

getGroups

@GET
 @Produces(value={"application/xml","application/json","application/atom+xml"})
public OnmsGroupList getGroups()

getGroup

@GET
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Path(value="{groupName}")
public OnmsGroup getGroup(@PathParam(value="groupName")
                                                                                                                                           String groupName)

addGroup

@POST
 @Consumes(value="application/xml")
public javax.ws.rs.core.Response addGroup(@Context
                                                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                                                    OnmsGroup group)

updateGroup

@PUT
 @Consumes(value="application/x-www-form-urlencoded")
 @Path(value="{groupName}")
public javax.ws.rs.core.Response updateGroup(@Context
                                                                                                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                    @PathParam(value="groupName")
                                                                                                                                    String groupName,
                                                                                                                                    MultivaluedMapImpl params)

deleteGroup

@DELETE
 @Path(value="{groupName}")
public javax.ws.rs.core.Response deleteGroup(@PathParam(value="groupName")
                                                                                 String groupName)

addUser

@PUT
 @Path(value="{groupName}/users/{userName}")
public javax.ws.rs.core.Response addUser(@Context
                                                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                                                           @PathParam(value="groupName")
                                                                                           String groupName,
                                                                                           @PathParam(value="userName")
                                                                                           String userName)

removeUser

@DELETE
 @Path(value="{groupName}/users/{userName}")
public javax.ws.rs.core.Response removeUser(@PathParam(value="groupName")
                                                                                                 String groupName,
                                                                                                 @PathParam(value="userName")
                                                                                                 String userName)

listUsersOfGroup

@GET
 @Path(value="{groupName}/users/")
public OnmsUserList listUsersOfGroup(@PathParam(value="groupName")
                                                                             String groupName)

getUser

@GET
 @Path(value="{groupName}/users/{userName}")
public OnmsUser getUser(@PathParam(value="groupName")
                                                                          String groupName,
                                                                          @PathParam(value="userName")
                                                                          String userName)

addCategory

@PUT
 @Path(value="{groupName}/categories/{categoryName}")
public OnmsCategory addCategory(@PathParam(value="groupName")
                                                                                           String groupName,
                                                                                           @PathParam(value="categoryName")
                                                                                           String categoryName)

removeCategory

@DELETE
 @Path(value="{groupName}/categories/{categoryName}")
public javax.ws.rs.core.Response removeCategory(@PathParam(value="groupName")
                                                                                                              String groupName,
                                                                                                              @PathParam(value="categoryName")
                                                                                                              String categoryName)

getCategoryForGroup

@GET
 @Path(value="{groupName}/categories/{categoryName}")
public OnmsCategory getCategoryForGroup(@PathParam(value="groupName")
                                                                                                   String groupName,
                                                                                                   @PathParam(value="categoryName")
                                                                                                   String categoryName)

listCategories

@GET
 @Path(value="{groupName}/categories")
public OnmsCategoryCollection listCategories(@PathParam(value="groupName")
                                                                                         String groupName)

getOnmsGroup

protected OnmsGroup getOnmsGroup(String groupName)