com.tsgrp.opencontent.core.user

Interface IUser

All Known Implementing Classes:

AlfrescoEmbUserImpl, DCTMUserImpl, DynamoUserImpl, ElasticsearchUserImpl, HBaseUserImpl, LDAPDynamoUserImpl, LDAPHBaseUserImpl, LDAPUserImpl, S3UserImpl, SolrUserImpl

public interface IUser

Interface for user/group related actions.

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) Deprecated. Use searchAuthorities(String, OCAuthoritySearchCriteria)
UserResult	findAllUsersInGroups(java.lang.String ticket, java.lang.String[] groupNames) Deprecated. use searchAuthorities(String, OCAuthoritySearchCriteria)
UserResult	findAllUsersInGroupsRecursive(java.lang.String ticket, java.lang.String[] groupNames) Deprecated. Use searchAuthorities(String, OCAuthoritySearchCriteria)
UserResult	findGroupsWithUser(java.lang.String ticket, java.lang.String loginName) Deprecated. There is no suitable replacement method yet for finding all of the users' groups, but this is deprecated since the performance is terrible for Documentum currently
OCUser	getAuthenticatedOcUser(java.lang.String ticket) Get the user identified by the authentication ticket.
UserResult	getAuthenticatedUser(java.lang.String ticket) Deprecated. Use getAuthenticatedOcUser(String) instead
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) Deprecated. if you need to use this method, you should write and expose one that doesn't use the UserResult wrapper object and one that makes use of the OCAuthority object.
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) Deprecated. if you need to use this method, you should write and expose one that doesn't use the UserResult wrapper object and one that makes use of the OCAuthority object.
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) Verify if a user belongs to a specific group.
boolean	isValidUser(java.lang.String ticket, java.lang.String userName) Checks to see if the given userName is a valid user
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) Deprecated. Use searchAuthorities(String, OCAuthoritySearchCriteria)
boolean	setUserInboxProxy(java.lang.String ticket, java.lang.String proxyUserLoginName) Sets the given user as a proxy user for any workflow tasks that are assigned to the session ticket owner.
boolean	updateUser(java.lang.String ticket, java.lang.String userName, java.lang.String displayName, 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.

Method Detail

isUserInGroup

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

Verify if a user belongs to a specific group.

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

getUser

@Deprecated
UserResult getUser(java.lang.String ticket,
                                java.lang.String loginName)

Deprecated. if you need to use this method, you should write and expose one that doesn't use the UserResult wrapper object and one that makes use of the OCAuthority object.

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

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

isValidUser

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

Checks to see if the given userName is a valid user

Parameters:

ticket - a valid authentication ticket

userName - user's login name

Returns:

true if is a valid user, false otherwise

getGroupDetails

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

Deprecated. if you need to use this method, you should write and expose one that doesn't use the UserResult wrapper object and one that makes use of the OCAuthority object.

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

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

findAllUsers

@Deprecated
UserResult findAllUsers(java.lang.String ticket)

Deprecated. Use searchAuthorities(String, OCAuthoritySearchCriteria)

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

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

findAllUsersInGroups

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

Deprecated. use searchAuthorities(String, OCAuthoritySearchCriteria)

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 searchAuthorities(String, OCAuthoritySearchCriteria) for documentum for groups

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

findAllUsersInGroupsRecursive

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

Deprecated. Use searchAuthorities(String, OCAuthoritySearchCriteria)

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 searchAuthorities(String, OCAuthoritySearchCriteria) for documentum for groups

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

searchUsersInGroup

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

Deprecated. Use searchAuthorities(String, OCAuthoritySearchCriteria)

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 searchAuthorities(String, OCAuthoritySearchCriteria) for documentum for groups Implementations should ensure that the search is case insensitive.

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.

findGroupsWithUser

@Deprecated
UserResult findGroupsWithUser(java.lang.String ticket,
                                           java.lang.String loginName)

Deprecated. There is no suitable replacement method yet for finding all of the users' groups, but this is deprecated since the performance is terrible for Documentum currently

Find all the groups that a user belongs to.

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

getAuthenticatedUser

@Deprecated
UserResult getAuthenticatedUser(java.lang.String ticket)

Deprecated. Use getAuthenticatedOcUser(String) instead

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

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

getAuthenticatedOcUser

OCUser getAuthenticatedOcUser(java.lang.String ticket)

Get the user identified by the authentication ticket.

Parameters:

ticket - a valid authentication ticket

Returns:

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

isAuthenticatedUserAdmin

boolean isAuthenticatedUserAdmin(java.lang.String ticket)

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

Parameters:

ticket - valid OC ticket

Returns:

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

getUserHomeDirectory

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

Retrieves the objectId of the specified user's home directory

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

getGroup

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

Retrieves a group based on the group ID

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

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

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.

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

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. See OCAuthoritySearchCriteria for details on how to configure the search.

Parameters:

ticket - a valid authentication ticket

{@link - OCAuthoritySearchCriteria} criteria

Returns:

OCAuthority list

getUsersInGroup

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. If the group specified by groupName is not found, an OCRuntimeException is thrown.

Parameters:

ticket - a valid authentication ticket

groupName - name of the group from which to get the child users

Returns:

a List of OCUser objects

resetUserPassword

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

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

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

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

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.

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

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

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.

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

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

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

Parameters:

ticket - a valid authentication ticket

groupToCreate - name of group to create in repository

Returns:

OCGroup group that was created in repository

deleteGroup

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

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.

Parameters:

ticket - a valid authentication ticket

groupToRemove - name of group to delete from repository

Returns:

boolean returns true if delete is successful

disableUser

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

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.

Parameters:

userToDisable - unique username of user to disable

Returns:

boolean returns true if successful

enableUser

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

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.

Parameters:

userToDisable - unique username of user to enable

Returns:

boolean returns true if successful

createUser

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

Parameters:

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

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

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

Parameters:

ticket -

userToRemove - userName of the the User to be removed

Returns:

boolean depending on success or failure

updateUser

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

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

Parameters:

ticket -

userName - the user to be updated

displayName - the updated displayName

email - the updated email address

password - the updated password

Returns:

boolean depending on success or failure

setUserInboxProxy

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

Sets the given user as a proxy user for any workflow tasks that are assigned to the session ticket owner. If a blank or null proxy user is given, any existing inbox proxy settings are removed and the session ticket owner will receive inbox tasks.

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

int getTotalUserCount(java.lang.String ticket)

Gets the total number of users in the repository.

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.

userForgotPassword

UserBean userForgotPassword(java.lang.String userName)

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.

Parameters:

email - email associated with the user that forgot their password

userName - user who forgot their password

Returns:

UserBean with users info

checkRecoveryCode

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

Parameters:

userName - the user to check the code to

code - Recovery code sent to the user

password - the updated password