Class UserService

java.lang.Object

com.netscape.cms.servlet.base.PKIService

com.netscape.cms.servlet.base.SubsystemService

org.dogtagpki.server.rest.UserService

All Implemented Interfaces:

UserResource

public class UserService
extends SubsystemService
implements UserResource

Author:

Endi S. Dewata

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACK_SLASH
static org.slf4j.Logger	logger
static final String	SYSTEM_USER
UGSubsystem	userGroupManager

Fields inherited from class com.netscape.cms.servlet.base.SubsystemService

auditor, authz, signedAuditLogger

Fields inherited from class com.netscape.cms.servlet.base.PKIService

bannerFile, DEFAULT_LONG_CACHE_LIFETIME, DEFAULT_SIZE, headers, MESSAGE_FORMATS, MIN_FILTER_LENGTH, request, servletContext, servletRequest, uriInfo

Fields inherited from interface com.netscape.certsrv.user.UserResource

ALL_PROFILES, ATTR_TPS_PROFILES

Constructor Summary

Constructors

Constructor	Description
UserService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addUser(UserData userData)	Adds a new user to LDAP server
javax.ws.rs.core.Response	addUserCert(String userID, UserCertData userCertData)	Adds a certificate to a user
javax.ws.rs.core.Response	addUserMembership(String userID, String groupID)
void	auditAddUser(String id, UserData userData, String status)
void	auditAddUserCert(String id, UserCertData userCertData, String status)
void	auditDeleteUser(String id, String status)
void	auditDeleteUserCert(String id, UserCertData userCertData, String status)
void	auditModifyUser(String id, UserData userData, String status)
void	auditUser(String type, String id, Map<String,String> params, String status)
void	auditUserCert(String type, String id, Map<String,String> params, String status)
UserCertData	createUserCertData(String userID, X509Certificate cert)
UserData	createUserData(User user)
UserMembershipData	createUserMembershipData(String userID, String groupID)
javax.ws.rs.core.Response	findUserCerts(String userID, Integer start, Integer size)	List user certificate(s) Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin
javax.ws.rs.core.Response	findUserMemberships(String userID, String filter, Integer start, Integer size)
javax.ws.rs.core.Response	findUsers(String filter, Integer start, Integer size)	Searches for users in LDAP directory.
javax.ws.rs.core.Response	getUser(String userID)	List user information.
javax.ws.rs.core.Response	getUserCert(String userID, String certID)
UserCertData	getUserCertData(String userID, String certID)
UserData	getUserData(String userID)
javax.ws.rs.core.Response	modifyUser(String userID, UserData userData)	Modifies an existing user in local scope.
javax.ws.rs.core.Response	removeUser(String userID)	removes a user.
void	removeUserCert(String userID, UserCertData userCertData)
javax.ws.rs.core.Response	removeUserCert(String userID, String certID)	Removes a certificate for a user
javax.ws.rs.core.Response	removeUserMembership(String userID, String groupID)

Methods inherited from class com.netscape.cms.servlet.base.SubsystemService

audit, auditConfigTokenGeneral, getResourceBundle, getSharedSubsystemConfDir, getSubsystemConfDir, getSubsystemName, getUserMessage

Methods inherited from class com.netscape.cms.servlet.base.PKIService

createCreatedResponse, createNoContentResponse, createOKResponse, createOKResponse, getBanner, getInstanceDir, getLocale, getParams, getResponseFormat, getResponseFormat, isBannerEnabled, marshall, resolveFormat, resolveFormat, sendConditionalGetResponse, unmarshall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static org.slf4j.Logger logger

BACK_SLASH

public static final String BACK_SLASH

See Also:

• Constant Field Values

SYSTEM_USER

public static final String SYSTEM_USER

See Also:

• Constant Field Values

userGroupManager

public UGSubsystem userGroupManager

Constructor Details

UserService

public UserService()

Method Details

createUserData

public UserData createUserData(User user)
                        throws Exception

Throws:

Exception

findUsers

public javax.ws.rs.core.Response findUsers(String filter,
 Integer start,
 Integer size)

Searches for users in LDAP directory. Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

Specified by:

findUsers in interface UserResource

getUser

public javax.ws.rs.core.Response getUser(String userID)

List user information. Certificates covered in a separate protocol for findUserCerts(). List of group memberships are also provided. Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

Specified by:

getUser in interface UserResource

getUserData

public UserData getUserData(String userID)

addUser

public javax.ws.rs.core.Response addUser(UserData userData)

Adds a new user to LDAP server

Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_ROLE used when configuring role information (anything under users/groups)

Specified by:

addUser in interface UserResource

Throws:

UnsupportedEncodingException

modifyUser

public javax.ws.rs.core.Response modifyUser(String userID,
 UserData userData)

Modifies an existing user in local scope.

Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_ROLE used when configuring role information (anything under users/groups)

Specified by:

modifyUser in interface UserResource

removeUser

public javax.ws.rs.core.Response removeUser(String userID)

removes a user. user not removed if belongs to any group (Administrators should remove the user from "uniquemember" of any group he/she belongs to before trying to remove the user itself.

Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_ROLE used when configuring role information (anything under users/groups)

Specified by:

removeUser in interface UserResource

createUserCertData

public UserCertData createUserCertData(String userID,
 X509Certificate cert)
                                throws Exception

Throws:

Exception

findUserCerts

public javax.ws.rs.core.Response findUserCerts(String userID,
 Integer start,
 Integer size)

List user certificate(s) Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

Specified by:

findUserCerts in interface UserResource

getUserCert

public javax.ws.rs.core.Response getUserCert(String userID,
 String certID)

Specified by:

getUserCert in interface UserResource

getUserCertData

public UserCertData getUserCertData(String userID,
 String certID)

addUserCert

public javax.ws.rs.core.Response addUserCert(String userID,
 UserCertData userCertData)

Adds a certificate to a user

Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_ROLE used when configuring role information (anything under users/groups)

Specified by:

addUserCert in interface UserResource

removeUserCert

public javax.ws.rs.core.Response removeUserCert(String userID,
 String certID)

Removes a certificate for a user

Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

In this method, "certDN" is actually a combination of version, serialNumber, issuerDN, and SubjectDN.

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_ROLE used when configuring role information (anything under users/groups)

Specified by:

removeUserCert in interface UserResource

removeUserCert

public void removeUserCert(String userID,
 UserCertData userCertData)

createUserMembershipData

public UserMembershipData createUserMembershipData(String userID,
 String groupID)
                                            throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

findUserMemberships

public javax.ws.rs.core.Response findUserMemberships(String userID,
 String filter,
 Integer start,
 Integer size)

Specified by:

findUserMemberships in interface UserResource

addUserMembership

public javax.ws.rs.core.Response addUserMembership(String userID,
 String groupID)

Specified by:

addUserMembership in interface UserResource

removeUserMembership

public javax.ws.rs.core.Response removeUserMembership(String userID,
 String groupID)

Specified by:

removeUserMembership in interface UserResource

auditAddUser

public void auditAddUser(String id,
 UserData userData,
 String status)

auditModifyUser

public void auditModifyUser(String id,
 UserData userData,
 String status)

auditDeleteUser

public void auditDeleteUser(String id,
 String status)

auditAddUserCert

public void auditAddUserCert(String id,
 UserCertData userCertData,
 String status)

auditDeleteUserCert

public void auditDeleteUserCert(String id,
 UserCertData userCertData,
 String status)

auditUser

public void auditUser(String type,
 String id,
 Map<String,String> params,
 String status)

auditUserCert

public void auditUserCert(String type,
 String id,
 Map<String,String> params,
 String status)