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 java.lang.String
BACK_SLASH
static org.slf4j.Logger
logger
static java.lang.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.ws.rs.core.Response
addUser(UserData userData)
Adds a new user to LDAP serverjavax.ws.rs.core.Response
addUserCert(java.lang.String userID, UserCertData userCertData)
Adds a certificate to a userjavax.ws.rs.core.Response
addUserMembership(java.lang.String userID, java.lang.String groupID)
void
auditAddUser(java.lang.String id, UserData userData, java.lang.String status)
void
auditAddUserCert(java.lang.String id, UserCertData userCertData, java.lang.String status)
void
auditDeleteUser(java.lang.String id, java.lang.String status)
void
auditDeleteUserCert(java.lang.String id, UserCertData userCertData, java.lang.String status)
void
auditModifyUser(java.lang.String id, UserData userData, java.lang.String status)
void
auditUser(java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String status)
void
auditUserCert(java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String status)
UserCertData
createUserCertData(java.lang.String userID, java.security.cert.X509Certificate cert)
UserData
createUserData(User user)
UserMembershipData
createUserMembershipData(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)
List user certificate(s) Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-adminjavax.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)
Searches for users in LDAP directory.javax.ws.rs.core.Response
getUser(java.lang.String userID)
List user information.javax.ws.rs.core.Response
getUserCert(java.lang.String userID, java.lang.String certID)
UserCertData
getUserCertData(java.lang.String userID, java.lang.String certID)
UserData
getUserData(java.lang.String userID)
javax.ws.rs.core.Response
modifyUser(java.lang.String userID, UserData userData)
Modifies an existing user in local scope.javax.ws.rs.core.Response
removeUser(java.lang.String userID)
removes a user.void
removeUserCert(java.lang.String userID, UserCertData userCertData)
javax.ws.rs.core.Response
removeUserCert(java.lang.String userID, java.lang.String certID)
Removes a certificate for a userjavax.ws.rs.core.Response
removeUserMembership(java.lang.String userID, java.lang.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
-
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
BACK_SLASH
public static final java.lang.String BACK_SLASH
- See Also:
- Constant Field Values
-
SYSTEM_USER
public static final java.lang.String SYSTEM_USER
- See Also:
- Constant Field Values
-
userGroupManager
public UGSubsystem userGroupManager
-
-
Method Detail
-
createUserData
public UserData createUserData(User user) throws java.lang.Exception
- Throws:
java.lang.Exception
-
findUsers
public javax.ws.rs.core.Response findUsers(java.lang.String filter, java.lang.Integer start, java.lang.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 interfaceUserResource
-
getUser
public javax.ws.rs.core.Response getUser(java.lang.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 interfaceUserResource
-
getUserData
public UserData getUserData(java.lang.String userID)
-
addUser
public javax.ws.rs.core.Response addUser(UserData userData)
Adds a new user to LDAP serverRequest/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 interfaceUserResource
- Throws:
java.io.UnsupportedEncodingException
-
modifyUser
public javax.ws.rs.core.Response modifyUser(java.lang.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 interfaceUserResource
-
removeUser
public javax.ws.rs.core.Response removeUser(java.lang.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 interfaceUserResource
-
createUserCertData
public UserCertData createUserCertData(java.lang.String userID, java.security.cert.X509Certificate cert) throws java.lang.Exception
- Throws:
java.lang.Exception
-
findUserCerts
public javax.ws.rs.core.Response findUserCerts(java.lang.String userID, java.lang.Integer start, java.lang.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 interfaceUserResource
-
getUserCert
public javax.ws.rs.core.Response getUserCert(java.lang.String userID, java.lang.String certID)
- Specified by:
getUserCert
in interfaceUserResource
-
getUserCertData
public UserCertData getUserCertData(java.lang.String userID, java.lang.String certID)
-
addUserCert
public javax.ws.rs.core.Response addUserCert(java.lang.String userID, UserCertData userCertData)
Adds a certificate to a userRequest/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 interfaceUserResource
-
removeUserCert
public javax.ws.rs.core.Response removeUserCert(java.lang.String userID, java.lang.String certID)
Removes a certificate for a userRequest/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 interfaceUserResource
-
removeUserCert
public void removeUserCert(java.lang.String userID, UserCertData userCertData)
-
createUserMembershipData
public UserMembershipData createUserMembershipData(java.lang.String userID, java.lang.String groupID) throws java.io.UnsupportedEncodingException
- Throws:
java.io.UnsupportedEncodingException
-
findUserMemberships
public javax.ws.rs.core.Response findUserMemberships(java.lang.String userID, java.lang.String filter, java.lang.Integer start, java.lang.Integer size)
- Specified by:
findUserMemberships
in interfaceUserResource
-
addUserMembership
public javax.ws.rs.core.Response addUserMembership(java.lang.String userID, java.lang.String groupID)
- Specified by:
addUserMembership
in interfaceUserResource
-
removeUserMembership
public javax.ws.rs.core.Response removeUserMembership(java.lang.String userID, java.lang.String groupID)
- Specified by:
removeUserMembership
in interfaceUserResource
-
auditAddUser
public void auditAddUser(java.lang.String id, UserData userData, java.lang.String status)
-
auditModifyUser
public void auditModifyUser(java.lang.String id, UserData userData, java.lang.String status)
-
auditDeleteUser
public void auditDeleteUser(java.lang.String id, java.lang.String status)
-
auditAddUserCert
public void auditAddUserCert(java.lang.String id, UserCertData userCertData, java.lang.String status)
-
auditDeleteUserCert
public void auditDeleteUserCert(java.lang.String id, UserCertData userCertData, java.lang.String status)
-
auditUser
public void auditUser(java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String status)
-
auditUserCert
public void auditUserCert(java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String status)
-
-