org.opennms.web.rest.v1

Class UserRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.UserRestService

@Component(value="userRestService")
 @Path(value="users")
 @Transactional
public class UserRestService
extends OnmsRestService

Basic Web Service using REST for OnmsUser 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
UserRestService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUser(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, OnmsUser user)
javax.ws.rs.core.Response	deleteUser(javax.ws.rs.core.SecurityContext securityContext, String userCriteria)
OnmsUser	getUser(javax.ws.rs.core.SecurityContext securityContext, String username)
OnmsUserList	getUsers(javax.ws.rs.core.SecurityContext securityContext)
javax.ws.rs.core.Response	updateUser(javax.ws.rs.core.SecurityContext securityContext, javax.ws.rs.core.UriInfo uriInfo, String userCriteria, 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

UserRestService

public UserRestService()

Method Detail

getUsers

@GET
 @Produces(value={"application/xml","application/json","application/atom+xml"})
public OnmsUserList getUsers(@Context
                                                                                                                  javax.ws.rs.core.SecurityContext securityContext)

getUser

@GET
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Path(value="{username}")
public OnmsUser getUser(@Context
                                                                                                                                        javax.ws.rs.core.SecurityContext securityContext,
                                                                                                                                        @PathParam(value="username")
                                                                                                                                        String username)

addUser

@POST
 @Consumes(value="application/xml")
public javax.ws.rs.core.Response addUser(@Context
                                                                                   javax.ws.rs.core.SecurityContext securityContext,
                                                                                   @Context
                                                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                                                   OnmsUser user)

updateUser

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

deleteUser

@DELETE
 @Path(value="{userCriteria}")
public javax.ws.rs.core.Response deleteUser(@Context
                                                                                   javax.ws.rs.core.SecurityContext securityContext,
                                                                                   @PathParam(value="userCriteria")
                                                                                   String userCriteria)