Package com.netscape.certsrv.user

Interface UserResource

  • All Known Implementing Classes:
    UserService
    @Path("admin/users")
public interface UserResource
    Author:
    Endi S. Dewata

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response addUser​(UserData userData)  
      javax.ws.rs.core.Response addUserCert​(java.lang.String userID, UserCertData userCertData)  
      javax.ws.rs.core.Response addUserMembership​(java.lang.String userID, java.lang.String groupID)  
      javax.ws.rs.core.Response findUserCerts​(java.lang.String userID, java.lang.Integer start, java.lang.Integer size)  
      javax.ws.rs.core.Response findUserMemberships​(java.lang.String userID, java.lang.String filter, java.lang.Integer start, java.lang.Integer size)  
      javax.ws.rs.core.Response findUsers​(java.lang.String filter, java.lang.Integer start, java.lang.Integer size)  
      javax.ws.rs.core.Response getUser​(java.lang.String userID)  
      javax.ws.rs.core.Response getUserCert​(java.lang.String userID, java.lang.String certID)  
      javax.ws.rs.core.Response modifyUser​(java.lang.String userID, UserData userData)  
      javax.ws.rs.core.Response removeUser​(java.lang.String userID)  
      javax.ws.rs.core.Response removeUserCert​(java.lang.String userID, java.lang.String certID)  
      javax.ws.rs.core.Response removeUserMembership​(java.lang.String userID, java.lang.String groupID)  
      javax.ws.rs.core.Response replaceUser​(java.lang.String userID, UserData userData)  

    • Method Detail

      • findUsers

        @GET
javax.ws.rs.core.Response findUsers​(@QueryParam("filter")
                                    java.lang.String filter,
                                    @QueryParam("start")
                                    java.lang.Integer start,
                                    @QueryParam("size")
                                    java.lang.Integer size)

      • addUser

        @POST
javax.ws.rs.core.Response addUser​(UserData userData)

      • getUser

        @GET
@Path("{userID}")
javax.ws.rs.core.Response getUser​(@PathParam("userID")
                                  java.lang.String userID)

      • replaceUser

        @PUT
@Path("{userID}")
javax.ws.rs.core.Response replaceUser​(@PathParam("userID")
                                      java.lang.String userID,
                                      UserData userData)

      • modifyUser

        @Path("{userID}")
javax.ws.rs.core.Response modifyUser​(@PathParam("userID")
                                     java.lang.String userID,
                                     UserData userData)

      • removeUser

        @DELETE
@Path("{userID}")
javax.ws.rs.core.Response removeUser​(@PathParam("userID")
                                     java.lang.String userID)

      • findUserCerts

        @GET
@Path("{userID}/certs")
javax.ws.rs.core.Response findUserCerts​(@PathParam("userID")
                                        java.lang.String userID,
                                        @QueryParam("start")
                                        java.lang.Integer start,
                                        @QueryParam("size")
                                        java.lang.Integer size)

      • addUserCert

        @POST
@Path("{userID}/certs")
javax.ws.rs.core.Response addUserCert​(@PathParam("userID")
                                      java.lang.String userID,
                                      UserCertData userCertData)

      • getUserCert

        @GET
@Path("{userID}/certs/{certID}")
javax.ws.rs.core.Response getUserCert​(@PathParam("userID")
                                      java.lang.String userID,
                                      @PathParam("certID")
                                      java.lang.String certID)

      • removeUserCert

        @DELETE
@Path("{userID}/certs/{certID}")
javax.ws.rs.core.Response removeUserCert​(@PathParam("userID")
                                         java.lang.String userID,
                                         @PathParam("certID")
                                         java.lang.String certID)

      • findUserMemberships

        @GET
@Path("{userID}/memberships")
javax.ws.rs.core.Response findUserMemberships​(@PathParam("userID")
                                              java.lang.String userID,
                                              @QueryParam("filter")
                                              java.lang.String filter,
                                              @QueryParam("start")
                                              java.lang.Integer start,
                                              @QueryParam("size")
                                              java.lang.Integer size)

      • addUserMembership

        @POST
@Path("{userID}/memberships")
javax.ws.rs.core.Response addUserMembership​(@PathParam("userID")
                                            java.lang.String userID,
                                            java.lang.String groupID)

      • removeUserMembership

        @DELETE
@Path("{userID}/memberships/{groupID}")
javax.ws.rs.core.Response removeUserMembership​(@PathParam("userID")
                                               java.lang.String userID,
                                               @PathParam("groupID")
                                               java.lang.String groupID)