Package com.atlassian.confluence.user.crowd

Class DefaultCrowdUserDirectoryHelper

java.lang.Object

com.atlassian.confluence.user.crowd.DefaultCrowdUserDirectoryHelper

All Implemented Interfaces:

CrowdUserDirectoryHelper

public class DefaultCrowdUserDirectoryHelper
extends Object
implements CrowdUserDirectoryHelper

Since:

6.12.0

Constructor Summary

Constructors

Constructor	Description
DefaultCrowdUserDirectoryHelper(com.atlassian.crowd.embedded.api.CrowdDirectoryService crowdDirectoryService, com.atlassian.crowd.manager.directory.DirectoryManager directoryManager, org.hibernate.SessionFactory sessionFactory)

Method Summary

Modifier and Type	Method	Description
List<com.atlassian.crowd.embedded.api.Directory>	getDirectoriesForGroup(com.atlassian.user.Group group)
List<com.atlassian.crowd.embedded.api.Directory>	getDirectoriesForGroup(String groupName)	a list of all user directories (including disabled) to which a given group belongs
List<com.atlassian.crowd.embedded.api.Directory>	getDirectoriesForUser(com.atlassian.user.User user)
List<com.atlassian.crowd.embedded.api.Directory>	getDirectoriesForUser(String username)
Optional<Integer>	getGroupCount(long directoryId)
Optional<Integer>	getMembershipCount(long directoryId)
Optional<com.atlassian.crowd.manager.directory.SynchronisationMode>	getSynchronisationMode(long directoryId)
Optional<Integer>	getUserCount(long directoryId)
CrowdUserDirectoryImplementation	getUserDirectoryImplementation(long directoryId)
boolean	isInternalUserStatusSupported(long directoryId)
boolean	isMembershipAggregationEnabled()	Returns whether membership aggregation is enabled or not.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCrowdUserDirectoryHelper

public DefaultCrowdUserDirectoryHelper(com.atlassian.crowd.embedded.api.CrowdDirectoryService crowdDirectoryService,
 com.atlassian.crowd.manager.directory.DirectoryManager directoryManager,
 org.hibernate.SessionFactory sessionFactory)

Method Details

getSynchronisationMode

public Optional<com.atlassian.crowd.manager.directory.SynchronisationMode> getSynchronisationMode(long directoryId)

Specified by:

getSynchronisationMode in interface CrowdUserDirectoryHelper

Returns:

the synchronisation mode of the directory, if supported

getUserDirectoryImplementation

public CrowdUserDirectoryImplementation getUserDirectoryImplementation(long directoryId)

Specified by:

getUserDirectoryImplementation in interface CrowdUserDirectoryHelper

Returns:

the implementation class of the directory as a CrowdUserDirectoryImplementation enum

getUserCount

public Optional<Integer> getUserCount(long directoryId)

Specified by:

getUserCount in interface CrowdUserDirectoryHelper

Returns:

the total number of users in a given user directory, if retrievable

getGroupCount

public Optional<Integer> getGroupCount(long directoryId)

Specified by:

getGroupCount in interface CrowdUserDirectoryHelper

Returns:

the total number of groups in a given user directory, if retrievable

getMembershipCount

public Optional<Integer> getMembershipCount(long directoryId)

Specified by:

getMembershipCount in interface CrowdUserDirectoryHelper

Returns:

the total number of memberships in a given user directory, if retrievable

getDirectoriesForUser

public List<com.atlassian.crowd.embedded.api.Directory> getDirectoriesForUser(com.atlassian.user.User user)

Specified by:

getDirectoriesForUser in interface CrowdUserDirectoryHelper

Returns:

a list of all user directories (including disabled) to which a given user belongs

getDirectoriesForUser

public List<com.atlassian.crowd.embedded.api.Directory> getDirectoriesForUser(String username)

Specified by:

getDirectoriesForUser in interface CrowdUserDirectoryHelper

Parameters:

username - the username of the user

Returns:

a list of all user directories (including disabled) to which a given user belongs

getDirectoriesForGroup

public List<com.atlassian.crowd.embedded.api.Directory> getDirectoriesForGroup(String groupName)

Description copied from interface: CrowdUserDirectoryHelper

a list of all user directories (including disabled) to which a given group belongs

Specified by:

getDirectoriesForGroup in interface CrowdUserDirectoryHelper

Parameters:

groupName - the name of the group

getDirectoriesForGroup

public List<com.atlassian.crowd.embedded.api.Directory> getDirectoriesForGroup(com.atlassian.user.Group group)

Specified by:

getDirectoriesForGroup in interface CrowdUserDirectoryHelper

Returns:

a list of all user directories (including disabled) to which a given group belongs

isMembershipAggregationEnabled

public boolean isMembershipAggregationEnabled()

Returns whether membership aggregation is enabled or not.

Specified by:

isMembershipAggregationEnabled in interface CrowdUserDirectoryHelper

Returns:

true if membership aggregation is enabled, false otherwise.

isInternalUserStatusSupported

public boolean isInternalUserStatusSupported(long directoryId)

Specified by:

isInternalUserStatusSupported in interface CrowdUserDirectoryHelper

Returns:

true if directory supports internal user status, false otherwise