Package org.dogtagpki.server.rest

Class UserService

    • Field Detail

      • logger

        public static org.slf4j.Logger logger

      • userGroupManager

        public UGSubsystem userGroupManager

    • Constructor Detail

      • UserService

        public UserService()

    • 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 interface UserResource

      • 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 interface UserResource

      • getUserData

        public UserData getUserData​(java.lang.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

      • replaceUser

        public javax.ws.rs.core.Response replaceUser​(java.lang.String userID,
                                             UserData userData)
        Replaces 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:
        replaceUser in interface UserResource

      • 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 interface UserResource

      • 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 interface UserResource

      • 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 interface UserResource

      • getUserCert

        public javax.ws.rs.core.Response getUserCert​(java.lang.String userID,
                                             java.lang.String certID)
        Specified by:
        getUserCert in interface UserResource

      • 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 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​(java.lang.String userID,
                                                java.lang.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​(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 interface UserResource

      • addUserMembership

        public javax.ws.rs.core.Response addUserMembership​(java.lang.String userID,
                                                   java.lang.String groupID)
        Specified by:
        addUserMembership in interface UserResource

      • removeUserMembership

        public javax.ws.rs.core.Response removeUserMembership​(java.lang.String userID,
                                                      java.lang.String groupID)
        Specified by:
        removeUserMembership in interface UserResource

      • 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)