Updated REST interface for users.

The REST interface for users has been modified to return Response objects
to allow better handling of server responses. Other REST interfaces will
be modified in subsequent patches. Once all interfaces are updated, the
client library can be updated to use RESTEasy 3.0 API. Clients using the
client library or XML/JSON directly are not affected by these changes.

Ticket #554

2 files changed, 32 insertions, 16 deletions

diff --git a/base/common/src/com/netscape/certsrv/user/UserClient.java b/base/common/src/com/netscape/certsrv/user/UserClient.java
index 33ed61d2a..ee9d90950 100644
--- a/base/common/src/com/netscape/certsrv/user/UserClient.java
+++ b/base/common/src/com/netscape/certsrv/user/UserClient.java
@@ -41,11 +41,13 @@ public class UserClient extends Client {
     }
 
     public UserCollection findUsers(String filter, Integer start, Integer size) {
-        return userClient.findUsers(filter, start, size);
+        Response response = userClient.findUsers(filter, start, size);
+        return client.getEntity(response, UserCollection.class);
     }
 
     public UserData getUser(String userID) {
-        return userClient.getUser(userID);
+        Response response = userClient.getUser(userID);
+        return client.getEntity(response, UserData.class);
     }
 
     public UserData addUser(UserData userData) {
@@ -59,15 +61,18 @@ public class UserClient extends Client {
     }
 
     public void removeUser(String userID) {
-        userClient.removeUser(userID);
+        Response response = userClient.removeUser(userID);
+        client.getEntity(response, Void.class);
     }
 
     public UserCertCollection findUserCerts(String userID, Integer start, Integer size) {
-        return userClient.findUserCerts(userID, start, size);
+        Response response = userClient.findUserCerts(userID, start, size);
+        return client.getEntity(response, UserCertCollection.class);
     }
 
     public UserCertData getUserCert(String userID, String certID) {
-        return userClient.getUserCert(userID, certID);
+        Response response = userClient.getUserCert(userID, certID);
+        return client.getEntity(response, UserCertData.class);
     }
 
     public UserCertData addUserCert(String userID, UserCertData userCertData) {
@@ -76,11 +81,13 @@ public class UserClient extends Client {
     }
 
     public void removeUserCert(String userID, String certID) {
-        userClient.removeUserCert(userID, certID);
+        Response response = userClient.removeUserCert(userID, certID);
+        client.getEntity(response, Void.class);
     }
 
     public UserMembershipCollection findUserMemberships(String userID, Integer start, Integer size) {
-        return userClient.findUserMemberships(userID, start, size);
+        Response response = userClient.findUserMemberships(userID, start, size);
+        return client.getEntity(response, UserMembershipCollection.class);
     }
 
     public UserMembershipData addUserMembership(String userID, String groupID) {
@@ -89,6 +96,7 @@ public class UserClient extends Client {
     }
 
     public void removeUserMembership(String userD, String groupID) {
-        userClient.removeUserMembership(userD, groupID);
+        Response response = userClient.removeUserMembership(userD, groupID);
+        client.getEntity(response, Void.class);
     }
 }
diff --git a/base/common/src/com/netscape/certsrv/user/UserResource.java b/base/common/src/com/netscape/certsrv/user/UserResource.java
index 90b46ef60..cbda69a4c 100644
--- a/base/common/src/com/netscape/certsrv/user/UserResource.java
+++ b/base/common/src/com/netscape/certsrv/user/UserResource.java
@@ -48,8 +48,9 @@ public interface UserResource {
     public static final String ALL_PROFILES = "All Profiles";
 
     @GET
+    @ClientResponseType(entityType=UserCollection.class)
     @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
-    public UserCollection findUsers(
+    public Response findUsers(
             @QueryParam("filter") String filter,
             @QueryParam("start") Integer start,
             @QueryParam("size") Integer size);
@@ -62,8 +63,9 @@ public interface UserResource {
 
     @GET
     @Path("{userID}")
+    @ClientResponseType(entityType=UserData.class)
     @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
-    public UserData getUser(@PathParam("userID") String userID);
+    public Response getUser(@PathParam("userID") String userID);
 
     @PUT
     @Path("{userID}")
@@ -81,13 +83,15 @@ public interface UserResource {
 
     @DELETE
     @Path("{userID}")
+    @ClientResponseType(entityType=Void.class)
     @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
-    public void removeUser(@PathParam("userID") String userID);
+    public Response removeUser(@PathParam("userID") String userID);
 
     @GET
     @Path("{userID}/certs")
+    @ClientResponseType(entityType=UserCertCollection.class)
     @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
-    public UserCertCollection findUserCerts(
+    public Response findUserCerts(
             @PathParam("userID") String userID,
             @QueryParam("start") Integer start,
             @QueryParam("size") Integer size);
@@ -102,18 +106,21 @@ public interface UserResource {
 
     @GET
     @Path("{userID}/certs/{certID}")
+    @ClientResponseType(entityType=UserCertData.class)
     @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
-    public UserCertData getUserCert(@PathParam("userID") String userID, @PathParam("certID") String certID);
+    public Response getUserCert(@PathParam("userID") String userID, @PathParam("certID") String certID);
 
     @DELETE
     @Path("{userID}/certs/{certID}")
+    @ClientResponseType(entityType=Void.class)
     @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
-    public void removeUserCert(@PathParam("userID") String userID, @PathParam("certID") String certID);
+    public Response removeUserCert(@PathParam("userID") String userID, @PathParam("certID") String certID);
 
     @GET
     @Path("{userID}/memberships")
+    @ClientResponseType(entityType=UserMembershipCollection.class)
     @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
-    public UserMembershipCollection findUserMemberships(
+    public Response findUserMemberships(
             @PathParam("userID") String userID,
             @QueryParam("start") Integer start,
             @QueryParam("size") Integer size);
@@ -127,6 +134,7 @@ public interface UserResource {
 
     @DELETE
     @Path("{userID}/memberships/{groupID}")
+    @ClientResponseType(entityType=Void.class)
     @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
-    public void removeUserMembership(@PathParam("userID") String userID, @PathParam("groupID") String groupID);
+    public Response removeUserMembership(@PathParam("userID") String userID, @PathParam("groupID") String groupID);
 }