com.tsgrp.opencontent.dynamo.user

Class LDAPDynamoUserImpl

java.lang.Object

com.tsgrp.opencontent.ldap.user.LDAPUserImpl

com.tsgrp.opencontent.dynamo.user.LDAPDynamoUserImpl

All Implemented Interfaces:

IUser

public class LDAPDynamoUserImpl
extends LDAPUserImpl

Field Summary

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

config

Constructor Summary

Constructors

Constructor and Description
LDAPDynamoUserImpl()

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.
OCGroup	createGroup(java.lang.String ticket, java.lang.String groupToCreate) Creates a new group in the repository.
boolean	deleteGroup(java.lang.String ticket, java.lang.String groupToRemove) Deletes group from 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 userName) Find all the groups that a 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.
com.amazonaws.services.dynamodbv2.document.Item	getGroupItem(java.lang.String groupName, DynamoConfig dynamoConfig) Returns a group item
java.util.List<java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.AttributeValue>>	getGroupItems(DynamoConfig dynamoConfig) Returns a list of all the groups
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 username) Retrieves the objectId of the specified user's home directory
boolean	isAuthenticatedUserAdmin(java.lang.String ticket) (non-Javadoc)
boolean	isUserInGroup(java.lang.String ticket, java.lang.String user, java.lang.String groupName) (non-Javadoc)
boolean	removeAuthorityFromGroup(java.lang.String ticket, java.lang.String authorityToRemove, java.lang.String groupToRemoveFrom) Removes an authority from a group in the repository.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPDynamoUserImpl

public LDAPDynamoUserImpl()

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

See Also:

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

getUserHomeDirectory

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

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

username - 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:

com.tsgrp.opencontent.ldap.user.LDAPUserImpl#getUserHomeDirectory(java.lang. String, java.lang.String)

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

See Also:

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

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

Overrides:

addAuthorityToGroup in class LDAPUserImpl

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

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

See Also:

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

isUserInGroup

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

(non-Javadoc)

Specified by:

isUserInGroup in interface IUser

Overrides:

isUserInGroup in class LDAPUserImpl

Parameters:

ticket - a valid authentication ticket

user - 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:

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

findGroupsWithUser

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

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

userName - 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:

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

Currently a recursive is not implemented so we call findAllUsersInGroups

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:

com.tsgrp.opencontent.ldap.user.LDAPUserImpl#getGroupDetails(java.lang. String, java.lang.String[])

getGroup

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

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

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

See Also:

LDAPUserImpl.getGroup(java.lang.String, java.lang.String)

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

See Also:

LDAPUserImpl.getGroups(java.lang.String, java.lang.String, boolean)

getGroupItem

@Cacheable(value="dynamo-group",
           key="#groupName")
public com.amazonaws.services.dynamodbv2.document.Item getGroupItem(java.lang.String groupName,
                                                                                                                                    DynamoConfig dynamoConfig)

Returns a group item

Parameters:

{String} - groupName

{DynamoConfig} - dynamoConfig

Returns:

{Item} group

getGroupItems

@Cacheable(value="dynamo-groups")
public java.util.List<java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.AttributeValue>> getGroupItems(DynamoConfig dynamoConfig)

Returns a list of all the groups

Parameters:

dynamoConfig -

Returns:

{List> list of groups

isAuthenticatedUserAdmin

public boolean isAuthenticatedUserAdmin(java.lang.String ticket)

(non-Javadoc)

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.

See Also:

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