com.tsgrp.opencontent.dctm.user

Class DCTMUserImpl

java.lang.Object

com.tsgrp.opencontent.dctm.user.DCTMUserImpl

All Implemented Interfaces:

IUser

public class DCTMUserImpl
extends java.lang.Object
implements IUser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DCTMUserImpl()

Method Summary

Modifier and Type	Method and Description
boolean	addAuthorityToGroup(java.lang.String ticket, java.lang.String authorityToAdd, java.lang.String groupToAddTo) Adds an authority to an existing group in the repository.
void	checkRecoveryCode(java.lang.String userName, java.lang.String code, java.lang.String password) Checks to see if the recovery code sent to the users email is the same as the one entered.
OCGroup	createGroup(java.lang.String ticket, java.lang.String groupToCreate) Creates a new group in the repository.
OCUser	createUser(java.lang.String ticket, java.lang.String userName, java.lang.String firstName, java.lang.String lastName, java.lang.String email, java.lang.String displayName, java.lang.String password) Creates a user in the repository.
boolean	deleteGroup(java.lang.String ticket, java.lang.String groupToRemove) Deletes group from repository.
boolean	deleteUser(java.lang.String ticket, java.lang.String userToRemove) Removes a user in the repository.
boolean	disableUser(java.lang.String ticket, java.lang.String userToDisable) Disables a user in the repository.
boolean	enableUser(java.lang.String ticket, java.lang.String userToEnable) Enables a user in the repository.
UserResult	findAllUsers(java.lang.String ticket) Find all the users in the repository, also returns groups for each user.
UserResult	findAllUsersInGroups(java.lang.String ticket, java.lang.String[] groupNames) Find all the users that exist within a group.
UserResult	findAllUsersInGroupsRecursive(java.lang.String ticket, java.lang.String[] groupNames) Find all the users that exist within a group.
UserResult	findGroupsWithUser(java.lang.String ticket, java.lang.String loginName) Find all the groups that a user belongs to.
OCUser	getAuthenticatedOcUser(java.lang.String ticket) Get the user identified by the authentication ticket.
UserResult	getAuthenticatedUser(java.lang.String ticket) Get the user identified by the authentication ticket and populates the groups the user belongs to.
OCGroup	getGroup(java.lang.String ticket, java.lang.String groupId) Retrieves a group based on the group ID
UserResult	getGroupDetails(java.lang.String ticket, java.lang.String[] groupNames) Get group details for the provided groupNames.
java.util.List<OCGroup>	getGroups(java.lang.String ticket, java.lang.String parentGroupId, boolean recursive) Gets a list of groups from the repository.
int	getTotalUserCount(java.lang.String ticket) Gets the total number of users in the repository.
UserResult	getUser(java.lang.String ticket, java.lang.String loginName) Get a user based on the user's login name.
java.lang.String	getUserHomeDirectory(java.lang.String ticket, java.lang.String loginName) Retrieves the objectId of the specified user's home directory
java.util.List<OCUser>	getUsersInGroup(java.lang.String ticket, java.lang.String parentGroupId) Gets a list of OCUser objects that are the users currently in groupName.
boolean	isAuthenticatedUserAdmin(java.lang.String ticket) Check to see if the authenticated user is an ECM repository administrator.
boolean	isUserInGroup(java.lang.String ticket, java.lang.String username, java.lang.String groupName) This method returns a userbean if the true or a empty result if false.
boolean	isValidUser(java.lang.String ticket, java.lang.String userName) Checks to see if the given userName is a valid user
protected UserResult	populateGroupBeans(java.lang.String ticket, java.lang.String[] groupNames, boolean recursive, java.lang.String whereClause, boolean populateUserBeans) Helper method to query and parse results into an array of UserBean, and allows other methods to pass in a partial query that simulates additional WHERE clauses.
protected UserResult	populateUserBeans(java.lang.String ticket, java.lang.String whereClause, boolean populateGroups) Helper method to query and parse results into an array of GroupBean, and allows other methods to pass in a partial query that simulates additional WHERE clauses
boolean	removeAuthorityFromGroup(java.lang.String ticket, java.lang.String authorityToRemove, java.lang.String groupToRemoveFrom) Removes an authority from a group in the repository.
boolean	resetUserPassword(java.lang.String ticket, java.lang.String oldPassword, java.lang.String newPassword) Resets a user's password.
java.util.List<OCAuthority>	searchAuthorities(java.lang.String ticket, OCAuthoritySearchCriteria criteria) Gets a list of OCAuthority from the repository based on the provided search criteria.
UserBean[]	searchUsersInGroup(java.lang.String ticket, java.lang.String groupName, java.lang.String searchTerm, boolean searchSubGroups) Searches for users in a given group (and potentially sub-groups) based on the search term provided.
boolean	setUserInboxProxy(java.lang.String ticket, java.lang.String proxyUserLoginName) remove display DCTM override of setUserInboxProxy.
boolean	updateUser(java.lang.String ticket, java.lang.String userName, java.lang.String newName, java.lang.String email, java.lang.String password) Updates the info for the given user.
UserBean	userForgotPassword(java.lang.String userName) Sets a recovery code and expiration time to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DCTMUserImpl

protected DCTMUserImpl()

Method Detail

getUser

public UserResult getUser(java.lang.String ticket,
                          java.lang.String loginName)

Description copied from interface: IUser

Get a user based on the user's login name. Note that this method does NOT have to populate the group beans on the returned UserBean

Specified by:

getUser in interface IUser

Parameters:

ticket - a valid authentication ticket

loginName - user's login name

Returns:

• UserResult
• error returns true if method failed, otherwise false
• userBeans - 1 single bean for the given loginName
• displayName - repo specific display name
• loginName - repo specific login name

See Also:

IUser.getUser(java.lang.String, java.lang.String)

isValidUser

public boolean isValidUser(java.lang.String ticket,
                           java.lang.String userName)

Description copied from interface: IUser

Checks to see if the given userName is a valid user

Specified by:

isValidUser in interface IUser

Parameters:

ticket - a valid authentication ticket

userName - user's login name

Returns:

true if is a valid user, false otherwise

See Also:

IUser.isValidUser(java.lang.String, java.lang.String)

getGroupDetails

public UserResult getGroupDetails(java.lang.String ticket,
                                  java.lang.String[] groupNames)

Description copied from interface: IUser

Get group details for the provided groupNames. This method only populates the metadata for the returned groups, no details regarding the members of groups are provided. This allows the user to retrieve multiple group details by passing in an array of group names

Specified by:

getGroupDetails in interface IUser

Parameters:

ticket - a valid authentication ticket

groupNames - group names to return detail of

Returns:

• UserResult
• error returns true if method failed, otherwise false
• groupBeans - each returned group
• displayName - repo specific display name
• groupName - group name

See Also:

IUser.getGroupDetails(java.lang.String, java.lang.String[])

findAllUsers

public UserResult findAllUsers(java.lang.String ticket)

Description copied from interface: IUser

Find all the users in the repository, also returns groups for each user.

Specified by:

findAllUsers in interface IUser

Parameters:

ticket - a valid authentication ticket

Returns:

• UserResult
• error returns true if method failed, otherwise false
• userBeans - each returned user
• displayName - repo specific display name
• loginName - repo specific login name
• groupName - groups the specific user belongs to

See Also:

IUser.findAllUsers(java.lang.String)

findAllUsersInGroups

public UserResult findAllUsersInGroups(java.lang.String ticket,
                                       java.lang.String[] groupNames)

Description copied from interface: IUser

Find all the users that exist within a group. This allows the user to retrieve users in multiple groups by passing in an array of group names TODO: Finish implementing IUser.searchAuthorities(String, OCAuthoritySearchCriteria) for documentum for groups

Specified by:

findAllUsersInGroups in interface IUser

Parameters:

ticket - a valid authentication ticket

groupNames - name of group to find users in

Returns:

• UserResult
• error returns true if method failed, otherwise false
• groupBeans - each group that was queried, fully populated
• displayName - repo specific display name
• groupName - group name
• users - fully populated UserBean in the group

See Also:

IUser.findAllUsersInGroups(java.lang.String, java.lang.String[])

searchUsersInGroup

public UserBean[] searchUsersInGroup(java.lang.String ticket,
                                     java.lang.String groupName,
                                     java.lang.String searchTerm,
                                     boolean searchSubGroups)

Description copied from interface: IUser

Searches for users in a given group (and potentially sub-groups) based on the search term provided. If the group name or search term is empty (or null), or if the group does not exist, this method returns an empty UserBean[]. TODO: Finish implementing IUser.searchAuthorities(String, OCAuthoritySearchCriteria) for documentum for groups Implementations should ensure that the search is case insensitive.

Specified by:

searchUsersInGroup in interface IUser

Parameters:

ticket - authentication ticket

groupName - the group to search

searchTerm - the search term

searchSubGroups - boolean that determines whether or not the search should recurse on sub-groups

Returns:

an array of UserBeans for each user that matches the search. Note that the user information will be populated, but group information will not. Calling UserBean#getGroupNames() will return an empty array.

See Also:

com.tsgrp.opencontent.core.user.IUser#searchUsersInGroup(java.lang.String, java.lang.String, java.lang.String)

findGroupsWithUser

public UserResult findGroupsWithUser(java.lang.String ticket,
                                     java.lang.String loginName)

Description copied from interface: IUser

Find all the groups that a user belongs to.

Specified by:

findGroupsWithUser in interface IUser

Parameters:

ticket - a valid authentication ticket

loginName - user's login name

Returns:

• UserResult
• error returns true if method failed, otherwise false
• groupBeans - each group the user belongs to, group does not have users populated
• displayName - repo specific display name
• groupName - group name

See Also:

IUser.findGroupsWithUser(java.lang.String, java.lang.String)

populateGroupBeans

protected UserResult populateGroupBeans(java.lang.String ticket,
                                        java.lang.String[] groupNames,
                                        boolean recursive,
                                        java.lang.String whereClause,
                                        boolean populateUserBeans)

Helper method to query and parse results into an array of UserBean, and allows other methods to pass in a partial query that simulates additional WHERE clauses. This method expects that the groupNames array does not have null entries (handle this in the calling method in order to cleanly fail and give a more specific error message as opposed to throwing a generic one here)

Parameters:

ticket -

groupNames - array of group names to parse into an IN query

whereClause - additional where clause to add to the query

populateUserBeans - whether the UserBean array should be populated for the GroupBeans

Returns:

populateUserBeans

protected UserResult populateUserBeans(java.lang.String ticket,
                                       java.lang.String whereClause,
                                       boolean populateGroups)

Helper method to query and parse results into an array of GroupBean, and allows other methods to pass in a partial query that simulates additional WHERE clauses

Parameters:

ticket -

whereClause - additional where clause to add to the query

populateGroups - whether the groups array should be populated

Returns:

findAllUsersInGroupsRecursive

public UserResult findAllUsersInGroupsRecursive(java.lang.String ticket,
                                                java.lang.String[] groupNames)

Description copied from interface: IUser

Find all the users that exist within a group. This method will recurse into all nested groups and return ALL users. This allows the user to retrieve users in multiple groups by passing in an array of group names TODO: Finish implementing IUser.searchAuthorities(String, OCAuthoritySearchCriteria) for documentum for groups

Specified by:

findAllUsersInGroupsRecursive in interface IUser

Parameters:

ticket - a valid authentication ticket

groupNames - name of group to find users in

Returns:

• UserResult
• error returns true if method failed, otherwise false
• groupBeans - each group that was queried, fully populated
• displayName - repo specific display name
• groupName - group name
• users - fully populated UserBean in the group

See Also:

IUser.findAllUsersInGroupsRecursive(String, String[])

isUserInGroup

public boolean isUserInGroup(java.lang.String ticket,
                             java.lang.String username,
                             java.lang.String groupName)

This method returns a userbean if the true or a empty result if false.

Specified by:

isUserInGroup in interface IUser

Parameters:

ticket - a valid authentication ticket

username - name of the user

groupName - name of the group to verify

Returns:

a UserResult with a UserBean if true, or empty result if false

• UserResult
• error returns true if method failed, otherwise false
• userBeans - a UserBean populated with the username if user is in group

See Also:

IUser.isUserInGroup(java.lang.String, java.lang.String, java.lang.String)

getAuthenticatedUser

public UserResult getAuthenticatedUser(java.lang.String ticket)

Description copied from interface: IUser

Get the user identified by the authentication ticket and populates the groups the user belongs to.

Specified by:

getAuthenticatedUser in interface IUser

Parameters:

ticket - a valid authentication ticket

Returns:

• UserResult
• error returns true if method failed, otherwise false
• userBeans - 1 single bean for the given loginName
• displayName - repo specific display name
• loginName - repo specific login name
• groupName - groups the specific user belongs to

See Also:

IUser.getAuthenticatedUser(java.lang.String)

isAuthenticatedUserAdmin

public boolean isAuthenticatedUserAdmin(java.lang.String ticket)

Description copied from interface: IUser

Check to see if the authenticated user is an ECM repository administrator.

Specified by:

isAuthenticatedUserAdmin in interface IUser

Parameters:

ticket - valid OC ticket

Returns:

boolean value indicating whether or not the authenticated user is a repository administrator.

getUserHomeDirectory

public java.lang.String getUserHomeDirectory(java.lang.String ticket,
                                             java.lang.String loginName)

Description copied from interface: IUser

Retrieves the objectId of the specified user's home directory

Specified by:

getUserHomeDirectory in interface IUser

Parameters:

ticket - a valid authentication ticket

loginName - The loginname of the use for which to retrieve a home directory

Returns:

A string representing the objectId of the specified user's home directory

See Also:

IUser.getUserHomeDirectory(String, String)

getGroup

public OCGroup getGroup(java.lang.String ticket,
                        java.lang.String groupId)

Description copied from interface: IUser

Retrieves a group based on the group ID

Specified by:

getGroup in interface IUser

Parameters:

ticket - a valid authentication ticket

groupId - the group to retrieve. Note - this is NOT the repository ID. It's the non-displayName.

Returns:

OCGroup representing the group or null if the group is not found

getGroups

public java.util.List<OCGroup> getGroups(java.lang.String ticket,
                                         java.lang.String parentGroupId,
                                         boolean recursive)

Description copied from interface: IUser

Gets a list of groups from the repository. If the parent group is blank, all groups are returned. If parent group is passed in, then get subgroups of the parent group. If the parent group is set, the recursive boolean indicates whether sub-groups should be returned recursively.

Specified by:

getGroups in interface IUser

Parameters:

ticket - a valid authentication ticket

parentGroupId - the parent group

recursive - true if you would like to return sub-groups of all sub-groups, false otherwise

Returns:

a List of OCGroup objects

searchAuthorities

public java.util.List<OCAuthority> searchAuthorities(java.lang.String ticket,
                                                     OCAuthoritySearchCriteria criteria)

Description copied from interface: IUser

Gets a list of OCAuthority from the repository based on the provided search criteria. See OCAuthoritySearchCriteria for details on how to configure the search.

Specified by:

searchAuthorities in interface IUser

Parameters:

ticket - a valid authentication ticket

Returns:

OCAuthority list

getUsersInGroup

public java.util.List<OCUser> getUsersInGroup(java.lang.String ticket,
                                              java.lang.String parentGroupId)

Description copied from interface: IUser

Gets a list of OCUser objects that are the users currently in groupName. If the group specified by groupName is not found, an OCRuntimeException is thrown.

Specified by:

getUsersInGroup in interface IUser

Parameters:

ticket - a valid authentication ticket

Returns:

a List of OCUser objects

resetUserPassword

public boolean resetUserPassword(java.lang.String ticket,
                                 java.lang.String oldPassword,
                                 java.lang.String newPassword)

Description copied from interface: IUser

Resets a user's password. Uses ticket to determine user. Throws OCRuntimException if it fails. Returns true if password change is successful.

Specified by:

resetUserPassword in interface IUser

Parameters:

ticket - a valid authentication ticket

oldPassword - the current password for the user

newPassword - the new password for the user

Returns:

boolean returns true if password change is successful

removeAuthorityFromGroup

public boolean removeAuthorityFromGroup(java.lang.String ticket,
                                        java.lang.String authorityToRemove,
                                        java.lang.String groupToRemoveFrom)

Description copied from interface: IUser

Removes an authority from a group in the repository. Throws an OCRuntimeException if it fails. Will fail if groupToRemoveFrom is not an existing group or authorityToRemove is not an existing authority in the repository. Returns true if the removal is successful.

Specified by:

removeAuthorityFromGroup in interface IUser

Parameters:

ticket - a valid authentication ticket

authorityToRemove - name of user or group to remove from groupToRemoveFrom

groupToRemoveFrom - name of group to remove authorityToRemove from

Returns:

boolean returns true if removal is successful

addAuthorityToGroup

public boolean addAuthorityToGroup(java.lang.String ticket,
                                   java.lang.String authorityToAdd,
                                   java.lang.String groupToAddTo)

Description copied from interface: IUser

Adds an authority to an existing group in the repository. Throws an OCRuntimeException if it fails. Will fail if groupToAddTo is not an existing group or authorityToAdd is not an existing authority in the repository. Returns true if the addition is successful.

Specified by:

addAuthorityToGroup in interface IUser

Parameters:

ticket - a valid authentication ticket

authorityToAdd - name of authority to add to groupToAddTo

groupToAddTo - name of group to add authorityToAdd to

Returns:

boolean returns true if addition is successful

createGroup

public OCGroup createGroup(java.lang.String ticket,
                           java.lang.String groupToCreate)

Description copied from interface: IUser

Creates a new group in the repository. Throws an OCRuntimeException if group creation fails. Returns OCGroup of the created group if successful.

Specified by:

createGroup in interface IUser

Parameters:

ticket - a valid authentication ticket

groupToCreate - name of group to create in repository

Returns:

OCGroup group that was created in repository

deleteGroup

public boolean deleteGroup(java.lang.String ticket,
                           java.lang.String groupToRemove)

Description copied from interface: IUser

Deletes group from repository. Throws OCRuntimeException if it fails. groupToRemove must be an existing group in the repository. Returns true if deleting of group is successful.

Specified by:

deleteGroup in interface IUser

Parameters:

ticket - a valid authentication ticket

groupToRemove - name of group to delete from repository

Returns:

boolean returns true if delete is successful

disableUser

public boolean disableUser(java.lang.String ticket,
                           java.lang.String userToDisable)

Description copied from interface: IUser

Disables a user in the repository. userToDisable must be an existing user in the repository. Throws an OCRuntimeException if it fails. Returns true if the disabling of the user is successful.

Specified by:

disableUser in interface IUser

userToDisable - unique username of user to disable

Returns:

boolean returns true if successful

enableUser

public boolean enableUser(java.lang.String ticket,
                          java.lang.String userToEnable)

Description copied from interface: IUser

Enables a user in the repository. userToEnable must be an existing user in the repository. Throws an OCRuntimeException if it fails. Returns true if the enable of the user is successful.

Specified by:

enableUser in interface IUser

Returns:

boolean returns true if successful

createUser

public OCUser createUser(java.lang.String ticket,
                         java.lang.String userName,
                         java.lang.String firstName,
                         java.lang.String lastName,
                         java.lang.String email,
                         java.lang.String displayName,
                         java.lang.String password)

Description copied from interface: IUser

Creates a user in the repository. The user cannot already be in the repository Throws an OCRuntimeException if it fails. Returns an OCuser if the creation of the user is successful. Returns a null if the creation of the user failed.

Specified by:

createUser in interface IUser

userName - Unique Username of new user

firstName - First name of new user, This is optional

lastName - Last name of new user, This is optional

email - email address of new user

password - new user

Returns:

OCUser returns the user

deleteUser

public boolean deleteUser(java.lang.String ticket,
                          java.lang.String userToRemove)

Description copied from interface: IUser

Removes a user in the repository. Throws an OCRuntimeException if it fails. Returns true if the disabling of the user is successful.

Specified by:

deleteUser in interface IUser

userToRemove - userName of the the User to be removed

Returns:

boolean depending on success or failure

setUserInboxProxy

public boolean setUserInboxProxy(java.lang.String ticket,
                                 java.lang.String proxyUserLoginName)

remove display DCTM override of setUserInboxProxy.

Specified by:

setUserInboxProxy in interface IUser

Parameters:

ticket - The ticket for the current session.

proxyUserLoginName - LoginName of the proxy user, if any.

Returns:

True if setting/unsetting the proxy is successful; false otherwise.

getTotalUserCount

public int getTotalUserCount(java.lang.String ticket)

Description copied from interface: IUser

Gets the total number of users in the repository.

Specified by:

getTotalUserCount in interface IUser

Parameters:

ticket - The ticket for the current session. Note that it is up to the implementation to handle a blank ticket, which will get the total user count with an admin session.

updateUser

public boolean updateUser(java.lang.String ticket,
                          java.lang.String userName,
                          java.lang.String newName,
                          java.lang.String email,
                          java.lang.String password)

Description copied from interface: IUser

Updates the info for the given user. Throws an OCRuntimeException if it fails. Returns true if updating the User is successful.

Specified by:

updateUser in interface IUser

userName - the user to be updated

newName - the updated displayName

email - the updated email address

password - the updated password

Returns:

boolean depending on success or failure

userForgotPassword

public UserBean userForgotPassword(java.lang.String userName)

Description copied from interface: IUser

Sets a recovery code and expiration time to the user. Then sends a email to that users email address with the recovery code. Throws an OCRuntimeException if it fails. Returns a UserBean with the users info.

Specified by:

userForgotPassword in interface IUser

Parameters:

userName - user who forgot their password

Returns:

UserBean with users info

checkRecoveryCode

public void checkRecoveryCode(java.lang.String userName,
                              java.lang.String code,
                              java.lang.String password)

Description copied from interface: IUser

Checks to see if the recovery code sent to the users email is the same as the one entered. If it is, update the password of that user Throws an OCRuntimeException if it fails. Returns a String indicating if it was successful or what error occured.

Specified by:

checkRecoveryCode in interface IUser

Parameters:

userName - the user to check the code to

code - Recovery code sent to the user

password - the updated password

getAuthenticatedOcUser

public OCUser getAuthenticatedOcUser(java.lang.String ticket)

Description copied from interface: IUser

Get the user identified by the authentication ticket.

Specified by:

getAuthenticatedOcUser in interface IUser

Parameters:

ticket - a valid authentication ticket

Returns:

• OCAuthority
• displayName - repo specific display name
• authorityId - repo specific login name or group name
• emailAddress - email address

See Also:

IUser.getAuthenticatedOcUser(java.lang.String ticket)