Package com.atlassian.confluence.user.crowd

Interface CrowdUserDirectoryHelper

  • All Known Implementing Classes:
    DefaultCrowdUserDirectoryHelper
    public interface CrowdUserDirectoryHelper
    Helper class for accessing information about Crowd user directories
    Since:
    6.12.0

    • Method Detail

      • getSynchronisationMode

        Optional<com.atlassian.crowd.manager.directory.SynchronisationMode> getSynchronisationMode​(long directoryId)
        Returns:
        the synchronisation mode of the directory, if supported

      • getUserDirectoryImplementation

        CrowdUserDirectoryImplementation getUserDirectoryImplementation​(long directoryId)
        Returns:
        the implementation class of the directory as a CrowdUserDirectoryImplementation enum

      • getUserCount

        Optional<Integer> getUserCount​(long directoryId)
        Returns:
        the total number of users in a given user directory, if retrievable

      • getGroupCount

        Optional<Integer> getGroupCount​(long directoryId)
        Returns:
        the total number of groups in a given user directory, if retrievable

      • getMembershipCount

        Optional<Integer> getMembershipCount​(long directoryId)
        Returns:
        the total number of memberships in a given user directory, if retrievable

      • getDirectoriesForUser

        List<com.atlassian.crowd.embedded.api.Directory> getDirectoriesForUser​(com.atlassian.user.User user)
        Returns:
        a list of all user directories (including disabled) to which a given user belongs
        Since:
        6.13.0