Modifier | Constructor and Description |
---|---|
protected |
S3UserImpl() |
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)
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)
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)
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 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.
|
public UserResult findAllUsers(java.lang.String ticket)
IUser
findAllUsers
in interface IUser
ticket
- a valid authentication ticketUserResult
error
returns true if method failed, otherwise falseuserBeans
- each returned userdisplayName
- repo specific display nameloginName
- repo specific login namegroupName
- groups the specific user belongs toIUser.findAllUsers(java.lang.String)
public UserResult findAllUsersInGroups(java.lang.String ticket, java.lang.String[] groupNames)
IUser
IUser.searchAuthorities(String, OCAuthoritySearchCriteria)
for documentum for groupsfindAllUsersInGroups
in interface IUser
ticket
- a valid authentication ticketgroupNames
- name of group to find users inUserResult
error
returns true if method failed, otherwise falsegroupBeans
- each group that was queried, fully populateddisplayName
- repo specific display namegroupName
- group nameusers
- fully populated UserBean
in the groupIUser.findAllUsersInGroups(java.lang.String,
java.lang.String[])
public UserResult findGroupsWithUser(java.lang.String ticket, java.lang.String loginName)
IUser
findGroupsWithUser
in interface IUser
ticket
- a valid authentication ticketloginName
- user's login nameUserResult
error
returns true if method failed, otherwise falsegroupBeans
- each group the user belongs to, group does not have users populateddisplayName
- repo specific display namegroupName
- group nameIUser.findGroupsWithUser(java.lang.String,
java.lang.String)
public UserResult getGroupDetails(java.lang.String ticket, java.lang.String[] groupNames)
IUser
getGroupDetails
in interface IUser
ticket
- a valid authentication ticketgroupNames
- group names to return detail ofUserResult
error
returns true if method failed, otherwise falsegroupBeans
- each returned groupdisplayName
- repo specific display namegroupName
- group nameIUser.getGroupDetails(java.lang.String,
java.lang.String[])
public UserResult getUser(java.lang.String ticket, java.lang.String loginName)
IUser
getUser
in interface IUser
ticket
- a valid authentication ticketloginName
- user's login nameUserResult
error
returns true if method failed, otherwise falseuserBeans
- 1 single bean for the given loginNamedisplayName
- repo specific display nameloginName
- repo specific login nameIUser.getUser(java.lang.String,
java.lang.String)
public boolean isValidUser(java.lang.String ticket, java.lang.String userName)
IUser
isValidUser
in interface IUser
ticket
- a valid authentication ticketuserName
- user's login nameIUser.isValidUser(java.lang.String,
java.lang.String)
public UserResult findAllUsersInGroupsRecursive(java.lang.String ticket, java.lang.String[] groupNames)
IUser
IUser.searchAuthorities(String, OCAuthoritySearchCriteria)
for documentum for groupsfindAllUsersInGroupsRecursive
in interface IUser
ticket
- a valid authentication ticketgroupNames
- name of group to find users inUserResult
error
returns true if method failed, otherwise falsegroupBeans
- each group that was queried, fully populateddisplayName
- repo specific display namegroupName
- group nameusers
- fully populated UserBean
in the groupIUser.findAllUsersInGroupsRecursive(String,
String[])
public boolean isUserInGroup(java.lang.String ticket, java.lang.String username, java.lang.String groupName)
IUser
isUserInGroup
in interface IUser
ticket
- a valid authentication ticketusername
- name of the usergroupName
- name of the group to verifypublic UserResult getAuthenticatedUser(java.lang.String ticket)
IUser
getAuthenticatedUser
in interface IUser
ticket
- a valid authentication ticketUserResult
error
returns true if method failed, otherwise falseuserBeans
- 1 single bean for the given loginNamedisplayName
- repo specific display nameloginName
- repo specific login namegroupName
- groups the specific user belongs toIUser.getAuthenticatedUser(java.lang.String)
public boolean isAuthenticatedUserAdmin(java.lang.String ticket)
IUser
isAuthenticatedUserAdmin
in interface IUser
ticket
- valid OC ticketboolean
value indicating whether or not the authenticated user is a repository administrator.public UserBean[] searchUsersInGroup(java.lang.String ticket, java.lang.String groupName, java.lang.String searchTerm, boolean searchSubGroups)
IUser
IUser.searchAuthorities(String, OCAuthoritySearchCriteria)
for documentum for groups
Implementations should ensure that the search is case insensitive.searchUsersInGroup
in interface IUser
ticket
- authentication ticketgroupName
- the group to searchsearchTerm
- the search termsearchSubGroups
- boolean that determines whether or not the search should recurse on sub-groupsUserBean#getGroupNames()
will return an empty array.public java.lang.String getUserHomeDirectory(java.lang.String ticket, java.lang.String loginName)
IUser
getUserHomeDirectory
in interface IUser
ticket
- a valid authentication ticketloginName
- The loginname of the use for which to retrieve a home directorypublic OCGroup getGroup(java.lang.String ticket, java.lang.String groupId)
IUser
public java.util.List<OCGroup> getGroups(java.lang.String ticket, java.lang.String parentGroupId, boolean recursive)
IUser
public java.util.List<OCAuthority> searchAuthorities(java.lang.String ticket, OCAuthoritySearchCriteria criteria)
IUser
OCAuthority
from the repository based on the provided search criteria.
See OCAuthoritySearchCriteria
for details on how to configure the search.searchAuthorities
in interface IUser
ticket
- a valid authentication ticketpublic java.util.List<OCUser> getUsersInGroup(java.lang.String ticket, java.lang.String parentGroupId)
IUser
getUsersInGroup
in interface IUser
ticket
- a valid authentication ticketOCUser
objectspublic boolean resetUserPassword(java.lang.String ticket, java.lang.String oldPassword, java.lang.String newPassword)
IUser
resetUserPassword
in interface IUser
ticket
- a valid authentication ticketoldPassword
- the current password for the usernewPassword
- the new password for the userpublic boolean removeAuthorityFromGroup(java.lang.String ticket, java.lang.String authorityToRemove, java.lang.String groupToRemoveFrom)
IUser
removeAuthorityFromGroup
in interface IUser
ticket
- a valid authentication ticketauthorityToRemove
- name of user or group to remove from groupToRemoveFromgroupToRemoveFrom
- name of group to remove authorityToRemove frompublic boolean addAuthorityToGroup(java.lang.String ticket, java.lang.String authorityToAdd, java.lang.String groupToAddTo)
IUser
addAuthorityToGroup
in interface IUser
ticket
- a valid authentication ticketauthorityToAdd
- name of authority to add to groupToAddTogroupToAddTo
- name of group to add authorityToAdd topublic OCGroup createGroup(java.lang.String ticket, java.lang.String groupToCreate)
IUser
createGroup
in interface IUser
ticket
- a valid authentication ticketgroupToCreate
- name of group to create in repositoryOCGroup
group that was created in repositorypublic boolean deleteGroup(java.lang.String ticket, java.lang.String groupToRemove)
IUser
deleteGroup
in interface IUser
ticket
- a valid authentication ticketgroupToRemove
- name of group to delete from repositorypublic boolean disableUser(java.lang.String ticket, java.lang.String userToDisable)
IUser
disableUser
in interface IUser
userToDisable
- unique username of user to disablepublic boolean enableUser(java.lang.String ticket, java.lang.String userToEnable)
IUser
enableUser
in interface IUser
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)
IUser
createUser
in interface IUser
userName
- Unique Username of new userfirstName
- First name of new user, This is optionallastName
- Last name of new user, This is optionalemail
- email address of new userpassword
- new userpublic boolean deleteUser(java.lang.String ticket, java.lang.String userToRemove)
IUser
deleteUser
in interface IUser
userToRemove
- userName of the the User to be removedpublic boolean setUserInboxProxy(java.lang.String ticket, java.lang.String proxyUserLoginName)
IUser
setUserInboxProxy
in interface IUser
ticket
- The ticket for the current session.proxyUserLoginName
- LoginName of the proxy user, if any.public int getTotalUserCount(java.lang.String ticket)
IUser
getTotalUserCount
in interface IUser
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.public boolean updateUser(java.lang.String ticket, java.lang.String userName, java.lang.String newName, java.lang.String email, java.lang.String password)
IUser
updateUser
in interface IUser
userName
- the user to be updatednewName
- the updated displayNameemail
- the updated email addresspassword
- the updated passwordpublic UserBean userForgotPassword(java.lang.String userName)
IUser
userForgotPassword
in interface IUser
userName
- user who forgot their passwordpublic void checkRecoveryCode(java.lang.String userName, java.lang.String code, java.lang.String password)
IUser
checkRecoveryCode
in interface IUser
userName
- the user to check the code tocode
- Recovery code sent to the userpassword
- the updated passwordpublic OCUser getAuthenticatedOcUser(java.lang.String ticket)
IUser
getAuthenticatedOcUser
in interface IUser
ticket
- a valid authentication ticketOCAuthority
displayName
- repo specific display nameauthorityId
- repo specific login name or group nameemailAddress
- email address