com.atlassian.confluence.user
Interface DisabledUserManager

All Known Implementing Classes:
CrowdDisabledUserManager

public interface DisabledUserManager

Manages the underlying changes to enable and disable users. Clients should not normally use this API directly, but instead call UserAccessor.isDeactivated(String) or UserAccessor.deactivateUser(com.atlassian.user.User) which take care of checking permissions and firing appropriate events.

Since:
3.5

Method Summary
 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(String username)
          Returns true if the user with the specified username is deactivated or does not exist, otherwise false.
 boolean isDisabled(com.atlassian.crowd.embedded.api.User user)
          Returns true if the specified user is deactivated or does not exist, otherwise false.
 

Method Detail

isDisabled

boolean isDisabled(com.atlassian.crowd.embedded.api.User user)
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.

Returns:
true if the specified user exists and is deactivated, otherwise false.

isDisabled

boolean isDisabled(String username)
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.

Returns:
true if the user with the specified username exists and is deactivated, otherwise false.

disableUser

void disableUser(com.atlassian.crowd.embedded.api.User user)
                 throws com.atlassian.crowd.exception.UserNotFoundException
Disables the specified user. Does nothing if the user is already disabled.

Parameters:
user - the user to disable
Throws:
com.atlassian.crowd.exception.UserNotFoundException - if the user does not exist
NullPointerException - if the user is null

enableUser

void enableUser(com.atlassian.crowd.embedded.api.User user)
                throws com.atlassian.crowd.exception.UserNotFoundException
Enables the specified user. Does nothing if the user is already enabled.

Parameters:
user - the user to enable
Throws:
com.atlassian.crowd.exception.UserNotFoundException - if the user does not exist
NullPointerException - if the user is null


Copyright © 2003-2011 Atlassian. All Rights Reserved.