Package com.atlassian.confluence.user.crowd

Class CrowdDisabledUserManager

java.lang.Object
com.atlassian.confluence.user.crowd.CrowdDisabledUserManager
All Implemented Interfaces:
DisabledUserManager
public final class CrowdDisabledUserManager extends Object implements DisabledUserManager
Implementation of DisabledUserManager which uses the Embedded Crowd service.
Since:
3.5

  • Constructor Summary

    Constructors
    Constructor
    Description
    CrowdDisabledUserManager(com.atlassian.crowd.embedded.api.CrowdService crowdService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disableEnableUserLocally(com.atlassian.crowd.embedded.api.User user, boolean doEnable)
    Disables the specified user in the internal confluence directory.
    void
    disableUser(com.atlassian.crowd.embedded.api.User user)
    Disables the specified user.
    void
    enableUser(com.atlassian.crowd.embedded.api.User user)
    Enables the specified user.
    boolean
    isDisabled(com.atlassian.crowd.embedded.api.User user)
    Returns true if the specified user is deactivated or does not exist, otherwise false.
    boolean
    isDisabled(com.atlassian.user.User user)
    As DisabledUserManager.isDisabled(User), but converts the given legacy User into a crowd User.
    boolean
    isDisabled(String username)
    Returns true if the user with the specified username is deactivated or does not exist, otherwise false.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CrowdDisabledUserManager

      public CrowdDisabledUserManager(com.atlassian.crowd.embedded.api.CrowdService crowdService)

  • Method Details

    • isDisabled

      public boolean isDisabled(com.atlassian.crowd.embedded.api.User user)
      Description copied from interface: DisabledUserManager
      Returns true if the specified user is deactivated or does not exist, otherwise false. Returns false if the user is null, indicating an anonymous user.
      Specified by:
      isDisabled in interface DisabledUserManager
      Returns:
      true if the specified user exists and is deactivated, otherwise false.

    • isDisabled

      public boolean isDisabled(com.atlassian.user.User user)
      Description copied from interface: DisabledUserManager
      As DisabledUserManager.isDisabled(User), but converts the given legacy User into a crowd User.
      Specified by:
      isDisabled in interface DisabledUserManager
      Returns:
      true if the specified user exists and is deactivated, otherwise false.

    • isDisabled

      public boolean isDisabled(String username)
      Description copied from interface: DisabledUserManager
      Returns true if the user with the specified username is deactivated or does not exist, otherwise false. Returns false if the username is null, indicating an anonymous user.
      Specified by:
      isDisabled in interface DisabledUserManager
      Returns:
      true if the user with the specified username exists and is deactivated, otherwise false.

    • disableUser

      public void disableUser(com.atlassian.crowd.embedded.api.User user) throws com.atlassian.user.impl.EntityValidationException, UserManagementOperationFailedException
      Description copied from interface: DisabledUserManager
      Disables the specified user. Does nothing if the user is already disabled.
      Specified by:
      disableUser in interface DisabledUserManager
      Parameters:
      user - the user to disable
      Throws:
      com.atlassian.user.impl.EntityValidationException
      UserManagementOperationFailedException

    • disableEnableUserLocally

      public void disableEnableUserLocally(com.atlassian.crowd.embedded.api.User user, boolean doEnable) throws com.atlassian.user.impl.EntityValidationException, UserManagementOperationFailedException
      Description copied from interface: DisabledUserManager
      Disables the specified user in the internal confluence directory. Does nothing if the user is already disabled.
      Specified by:
      disableEnableUserLocally in interface DisabledUserManager
      Parameters:
      user - the user to disable
      doEnable - whether to enable or disable
      Throws:
      com.atlassian.user.impl.EntityValidationException
      UserManagementOperationFailedException

    • enableUser

      public void enableUser(com.atlassian.crowd.embedded.api.User user) throws com.atlassian.user.impl.EntityValidationException, UserManagementOperationFailedException
      Description copied from interface: DisabledUserManager
      Enables the specified user. Does nothing if the user is already enabled.
      Specified by:
      enableUser in interface DisabledUserManager
      Parameters:
      user - the user to enable
      Throws:
      com.atlassian.user.impl.EntityValidationException
      UserManagementOperationFailedException