com.netscape.cms.servlet.admin

Class UserService

java.lang.Object

com.netscape.cms.servlet.base.PKIService

com.netscape.cms.servlet.admin.UserService

All Implemented Interfaces:

UserResource

public class UserService
extends PKIService
implements UserResource

Author:

Endi S. Dewata

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BACK_SLASH
static int	DEFAULT_SIZE
static java.lang.String	SYSTEM_USER
IUGSubsystem	userGroupManager

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

auditor, DEFAULT_LONG_CACHE_LIFETIME, HEADER, headers, logger, request, servletRequest, TRAILER, uriInfo

Constructor Summary

Constructors

Constructor and Description
UserService()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUser(UserData userData) Adds a new user to LDAP server
void	audit(java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String status)
void	auditAddUser(java.lang.String id, UserData userData, java.lang.String status)
void	auditDeleteUser(java.lang.String id, java.lang.String status)
void	auditModifyUser(java.lang.String id, UserData userData, java.lang.String status)
UserData	createUserData(IUser user)
UserCollection	findUsers(java.lang.String filter, java.lang.Integer start, java.lang.Integer size) Searches for users in LDAP directory.
UserData	getUser(java.lang.String userID) List user information.
void	log(int level, java.lang.String message)
javax.ws.rs.core.Response	modifyUser(java.lang.String userID, UserData userData) Modifies an existing user in local scope.
void	removeUser(java.lang.String userID) removes a user.

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

audit, createCertificateData, createOKResponse, getLocale, getParams, getUserMessage, log, sendConditionalGetResponse

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

Constant Field Values

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 IUGSubsystem userGroupManager

Constructor Detail

UserService

public UserService()

Method Detail

createUserData

public UserData createUserData(IUser user)
                        throws java.lang.Exception

Throws:

java.lang.Exception

findUsers

public UserCollection 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 UserData 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

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

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 void 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

log

public void log(int level,
       java.lang.String message)

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)

audit

public void audit(java.lang.String type,
         java.lang.String id,
         java.util.Map<java.lang.String,java.lang.String> params,
         java.lang.String status)