Constructor and Description |
---|
DynamoUserImpl() |
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)
Unimplemented
|
boolean |
enableUser(java.lang.String ticket,
java.lang.String userToEnable)
Unimplemented
|
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 username)
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 groupName)
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 username)
Get a user based on the user's login name.
|
java.lang.String |
getUserHomeDirectory(java.lang.String ticket,
java.lang.String username)
Unimplemented
|
java.util.List<OCUser> |
getUsersInGroup(java.lang.String ticket,
java.lang.String groupId)
Unimplemented
|
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)
Unimplemented
|
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)
Unimplemented
|
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)
Unimplemented
|
void |
setRecoveryPasswordFrom(java.lang.String emailAddress) |
boolean |
setUserInboxProxy(java.lang.String ticket,
java.lang.String proxyUserLoginName)
Unimplemented
|
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.
|
@Value(value="${email.passwordRecovery.from}") public void setRecoveryPasswordFrom(java.lang.String emailAddress)
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 verifyIUser.isUserInGroup(java.lang.String,
java.lang.String, java.lang.String)
public UserResult getUser(java.lang.String ticket, java.lang.String username)
IUser
getUser
in interface IUser
ticket
- a valid authentication ticketusername
- 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)
isValidUser
in interface IUser
ticket
- a valid authentication ticketusername
- user's login nameIUser.isValidUser(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 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 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 groupcom.tsgrp.opencontent.core.user.IUser#findAllUsersInGroupsRecursive(java.lang
.String, java.lang.String[])
public UserBean[] searchUsersInGroup(java.lang.String ticket, java.lang.String groupName, java.lang.String searchTerm, boolean searchSubGroups)
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.IUser.searchUsersInGroup(java.lang.String,
java.lang.String, java.lang.String, boolean)
public UserResult findGroupsWithUser(java.lang.String ticket, java.lang.String username)
IUser
findGroupsWithUser
in interface IUser
ticket
- a valid authentication ticketusername
- 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 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.com.tsgrp.opencontent.core.user.IUser#isAuthenticatedUserAdmin(java.lang.
String)
public java.lang.String getUserHomeDirectory(java.lang.String ticket, java.lang.String username)
getUserHomeDirectory
in interface IUser
ticket
- a valid authentication ticketusername
- The loginname of the use for which to retrieve a home directoryIUser.getUserHomeDirectory(java.lang.String,
java.lang.String)
public OCGroup getGroup(java.lang.String ticket, java.lang.String groupName)
IUser
getGroup
in interface IUser
ticket
- a valid authentication ticketgroupName
- the group to retrieve. Note - this is NOT the repository ID. It's the non-displayName.OCGroup
representing the group or null
if the group is not foundIUser.getGroup(java.lang.String,
java.lang.String)
public java.util.List<OCGroup> getGroups(java.lang.String ticket, java.lang.String parentGroupId, boolean recursive)
IUser
getGroups
in interface IUser
ticket
- a valid authentication ticketparentGroupId
- the parent grouprecursive
- true
if you would like to return sub-groups of all sub-groups, false
otherwiseOCGroup
objectsIUser.getGroups(java.lang.String,
java.lang.String, boolean)
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 ticketIUser.searchAuthorities(java.lang.String,
com.tsgrp.opencontent.core.query.model.OCAuthoritySearchCriteria)
public java.util.List<OCUser> getUsersInGroup(java.lang.String ticket, java.lang.String groupId)
getUsersInGroup
in interface IUser
ticket
- a valid authentication ticketOCUser
objectsIUser.getUsersInGroup(java.lang.String,
java.lang.String)
public boolean resetUserPassword(java.lang.String ticket, java.lang.String oldPassword, java.lang.String newPassword)
resetUserPassword
in interface IUser
ticket
- a valid authentication ticketoldPassword
- the current password for the usernewPassword
- the new password for the userIUser.resetUserPassword(java.lang.String,
java.lang.String, java.lang.String)
@CacheEvict(value="dynamo-groups",allEntries=true) @CacheEvict(value="dynamo-group",key="#groupToRemoveFrom") public 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 fromcom.tsgrp.opencontent.core.user.IUser#removeAuthorityFromGroup(java.lang.
String, java.lang.String, java.lang.String)
@CacheEvict(value="dynamo-groups",allEntries=true) @CacheEvict(value="dynamo-group",key="#groupToAddTo") public 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 toIUser.addAuthorityToGroup(java.lang.String,
java.lang.String, java.lang.String)
@CacheEvict(value="dynamo-groups", allEntries=true) public 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 repositoryIUser.createGroup(java.lang.String,
java.lang.String)
@CacheEvict(value="dynamo-groups",allEntries=true) @CacheEvict(value="dynamo-group",key="#groupToRemove") public 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 repositoryIUser.deleteGroup(java.lang.String,
java.lang.String)
public boolean disableUser(java.lang.String ticket, java.lang.String userToDisable)
disableUser
in interface IUser
userToDisable
- unique username of user to disableIUser.disableUser(java.lang.String,
java.lang.String)
public boolean enableUser(java.lang.String ticket, java.lang.String userToEnable)
enableUser
in interface IUser
IUser.enableUser(java.lang.String,
java.lang.String)
public boolean setUserInboxProxy(java.lang.String ticket, java.lang.String proxyUserLoginName)
setUserInboxProxy
in interface IUser
ticket
- The ticket for the current session.proxyUserLoginName
- LoginName of the proxy user, if any.IUser.setUserInboxProxy(java.lang.String,
java.lang.String)
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.@CacheEvict(value="dynamo-users", allEntries=true) 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 userIUser.createUser(java.lang.String,
java.lang.String, java.lang.String, java.lang.String, java.lang.String,
java.lang.String, java.lang.String)
@CacheEvict(value="dynamo-users",allEntries=true) @CacheEvict(value="dynamo-user",key="#userToRemove") public boolean deleteUser(java.lang.String ticket, java.lang.String userToRemove)
IUser
deleteUser
in interface IUser
userToRemove
- userName of the the User to be removedIUser.deleteUser(java.lang.String,
java.lang.String)
@CacheEvict(value="dynamo-users",allEntries=true) @CacheEvict(value="dynamo-user",key="#username") public boolean updateUser(java.lang.String ticket, java.lang.String username, java.lang.String displayName, java.lang.String email, java.lang.String password)
IUser
updateUser
in interface IUser
username
- the user to be updateddisplayName
- the updated displayNameemail
- the updated email addresspassword
- the updated passwordIUser.updateUser(java.lang.String,
java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public UserBean userForgotPassword(java.lang.String username)
IUser
userForgotPassword
in interface IUser
username
- user who forgot their passwordIUser.userForgotPassword(java.lang.String)
public 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 passwordIUser.checkRecoveryCode(java.lang.String,
java.lang.String, java.lang.String)
public 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 addressIUser.getAuthenticatedOcUser(java.lang.String
ticket)