com.netscape.certsrv.user

Interface UserResource

@Path(value="admin/users")
public interface UserResource

Author:

Endi S. Dewata

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_PROFILES
static java.lang.String	ATTR_TPS_PROFILES

Method Summary

Methods

Modifier and Type	Method and 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)
UserCertCollection	findUserCerts(java.lang.String userID, java.lang.Integer start, java.lang.Integer size)
UserMembershipCollection	findUserMemberships(java.lang.String userID, java.lang.Integer start, java.lang.Integer size)
UserCollection	findUsers(java.lang.String filter, java.lang.Integer start, java.lang.Integer size)
UserData	getUser(java.lang.String userID)
UserCertData	getUserCert(java.lang.String userID, java.lang.String certID)
javax.ws.rs.core.Response	modifyUser(java.lang.String userID, UserData userData)
void	removeUser(java.lang.String userID)
void	removeUserCert(java.lang.String userID, java.lang.String certID)
void	removeUserMembership(java.lang.String userID, java.lang.String groupID)

Field Detail

ATTR_TPS_PROFILES

static final java.lang.String ATTR_TPS_PROFILES

See Also:

Constant Field Values

ALL_PROFILES

static final java.lang.String ALL_PROFILES

See Also:

Constant Field Values

Method Detail

findUsers

@GET
@Produces(value={"application/xml","application/json"})
UserCollection findUsers(@QueryParam(value="filter")
                                    java.lang.String filter,
                                    @QueryParam(value="start")
                                    java.lang.Integer start,
                                    @QueryParam(value="size")
                                    java.lang.Integer size)

addUser

@POST
@Consumes(value={"application/xml","application/json"})
@Produces(value={"application/xml","application/json"})
javax.ws.rs.core.Response addUser(UserData userData)

getUser

@GET
@Path(value="{userID}")
@Produces(value={"application/xml","application/json"})
UserData getUser(@PathParam(value="userID")
                                 java.lang.String userID)

modifyUser

@POST
@Path(value="{userID}")
@Consumes(value={"application/xml","application/json"})
@Produces(value={"application/xml","application/json"})
javax.ws.rs.core.Response modifyUser(@PathParam(value="userID")
                                                               java.lang.String userID,
                                                               UserData userData)

removeUser

@DELETE
@Path(value="{userID}")
@Produces(value={"application/xml","application/json"})
void removeUser(@PathParam(value="userID")
                                   java.lang.String userID)

findUserCerts

@GET
@Path(value="{userID}/certs")
@Produces(value={"application/xml","application/json"})
UserCertCollection findUserCerts(@PathParam(value="userID")
                                                 java.lang.String userID,
                                                 @QueryParam(value="start")
                                                 java.lang.Integer start,
                                                 @QueryParam(value="size")
                                                 java.lang.Integer size)

addUserCert

@POST
@Path(value="{userID}/certs")
@Consumes(value={"application/xml","application/json"})
@Produces(value={"application/xml","application/json"})
javax.ws.rs.core.Response addUserCert(@PathParam(value="userID")
                                                                java.lang.String userID,
                                                                UserCertData userCertData)

getUserCert

@GET
@Path(value="{userID}/certs/{certID}")
@Produces(value={"application/xml","application/json"})
UserCertData getUserCert(@PathParam(value="userID")
                                         java.lang.String userID,
                                         @PathParam(value="certID")
                                         java.lang.String certID)

removeUserCert

@DELETE
@Path(value="{userID}/certs/{certID}")
@Produces(value={"application/xml","application/json"})
void removeUserCert(@PathParam(value="userID")
                                       java.lang.String userID,
                                       @PathParam(value="certID")
                                       java.lang.String certID)

findUserMemberships

@GET
@Path(value="{userID}/memberships")
@Produces(value={"application/xml","application/json"})
UserMembershipCollection findUserMemberships(@PathParam(value="userID")
                                                             java.lang.String userID,
                                                             @QueryParam(value="start")
                                                             java.lang.Integer start,
                                                             @QueryParam(value="size")
                                                             java.lang.Integer size)

addUserMembership

@POST
@Path(value="{userID}/memberships")
@Consumes(value={"application/xml","application/json"})
@Produces(value={"application/xml","application/json"})
javax.ws.rs.core.Response addUserMembership(@PathParam(value="userID")
                                                                      java.lang.String userID,
                                                                      java.lang.String groupID)

removeUserMembership

@DELETE
@Path(value="{userID}/memberships/{groupID}")
@Produces(value={"application/xml","application/json"})
void removeUserMembership(@PathParam(value="userID")
                                             java.lang.String userID,
                                             @PathParam(value="groupID")
                                             java.lang.String groupID)