com.tsgrp.opencontent.hbase.user

Class LDAPHBaseUserImpl

java.lang.Object

com.tsgrp.opencontent.ldap.user.LDAPUserImpl

com.tsgrp.opencontent.hbase.user.LDAPHBaseUserImpl

All Implemented Interfaces:

IUser

public class LDAPHBaseUserImpl
extends LDAPUserImpl

Field Summary

Fields inherited from class com.tsgrp.opencontent.ldap.user.LDAPUserImpl

config

Constructor Summary

Constructors

Constructor and Description
LDAPHBaseUserImpl()

Method Summary

Modifier and Type	Method and Description
boolean	addAuthorityToGroup(java.lang.String ticket, java.lang.String username, java.lang.String groupToAddTo) Adds an authority to an existing group in the repository.
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.
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.
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.
java.lang.String	getUserHomeDirectory(java.lang.String ticket, java.lang.String loginName) Retrieves the objectId of the specified user's home directory
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	removeAuthorityFromGroup(java.lang.String ticket, java.lang.String authorityToRemove, java.lang.String groupToRemoveFrom) Removes an authority from a group in the repository.
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.
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.

Methods inherited from class com.tsgrp.opencontent.ldap.user.LDAPUserImpl

checkRecoveryCode, disableUser, enableUser, findAllUsers, getAuthenticatedOcUser, getAuthenticatedUser, getTotalUserCount, getUser, getUsersInGroup, isValidUser, resetUserPassword, searchUsersInGroup, setLdapConfig, setUserInboxProxy, userForgotPassword

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPHBaseUserImpl

public LDAPHBaseUserImpl()

Method Detail

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

Overrides:

createGroup in class LDAPUserImpl

Parameters:

ticket - a valid authentication ticket

groupToCreate - name of group to create in repository

Returns:

OCGroup group that was created in repository

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

Overrides:

getUserHomeDirectory in class LDAPUserImpl

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

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

Overrides:

deleteGroup in class LDAPUserImpl

Parameters:

ticket - a valid authentication ticket

groupToRemove - name of group to delete from repository

Returns:

boolean returns true if delete is successful

addAuthorityToGroup

public boolean addAuthorityToGroup(java.lang.String ticket,
                                   java.lang.String username,
                                   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

Overrides:

addAuthorityToGroup in class LDAPUserImpl

Parameters:

ticket - a valid authentication ticket

username - name of authority to add to groupToAddTo

groupToAddTo - name of group to add authorityToAdd to

Returns:

boolean returns true if addition is successful

See Also:

com.tsgrp.opencontent.core.user.RestUser#ADD_USER_TO_GROUP(java.lang.String, java.lang.String)

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

Overrides:

removeAuthorityFromGroup in class LDAPUserImpl

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

isUserInGroup

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

Description copied from interface: IUser

Verify if a user belongs to a specific group.

Specified by:

isUserInGroup in interface IUser

Overrides:

isUserInGroup in class LDAPUserImpl

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

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

Overrides:

findGroupsWithUser in class LDAPUserImpl

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)

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

Overrides:

findAllUsersInGroups in class LDAPUserImpl

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:

com.tsgrp.opencontent.core.user.RestUser#findAllUsersInGroups(java.lang.String, java.lang.String)

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

Overrides:

findAllUsersInGroupsRecursive in class LDAPUserImpl

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[])

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

Overrides:

searchAuthorities in class LDAPUserImpl

Parameters:

ticket - a valid authentication ticket

Returns:

OCAuthority list

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

Overrides:

getGroupDetails in class LDAPUserImpl

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[])

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

Overrides:

getGroup in class LDAPUserImpl

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

Overrides:

getGroups in class LDAPUserImpl

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

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

Overrides:

createUser in class LDAPUserImpl

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

Overrides:

deleteUser in class LDAPUserImpl

userToRemove - userName of the the User to be removed

Returns:

boolean depending on success or failure

updateUser

public boolean updateUser(java.lang.String ticket,
                          java.lang.String userName,
                          java.lang.String displayName,
                          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

Overrides:

updateUser in class LDAPUserImpl

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

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

Overrides:

isAuthenticatedUserAdmin in class LDAPUserImpl

Parameters:

ticket - valid OC ticket

Returns:

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