com.atlassian.confluence.user.crowd
Class CrowdDisabledUserManager

java.lang.Object
  com.atlassian.confluence.user.crowd.CrowdDisabledUserManager

All Implemented Interfaces:

DeactivatedUserChecker, DisabledUserManager

public final class CrowdDisabledUserManager
extends Object
implements DisabledUserManager, DeactivatedUserChecker

Implementation of DisabledUserManager which uses the Embedded Crowd service.

Since:

3.5

Constructor Summary

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

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	isDeactivated(String username) Deprecated. since 3.5 use isDisabled(String)
boolean	isDeactivated(com.atlassian.user.User user) Deprecated. since 3.5 use isDisabled(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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrowdDisabledUserManager

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

Method Detail

isDeactivated

@Deprecated
public boolean isDeactivated(com.atlassian.user.User user)

Deprecated. since 3.5 use isDisabled(User)

Description copied from interface: DeactivatedUserChecker

Determines if the specified user is deactivated.

Specified by:

isDeactivated in interface DeactivatedUserChecker

Parameters:

user - The user object

Returns:

true if the specified user is deactivated, false otherwise.

isDeactivated

@Deprecated
public boolean isDeactivated(String username)

Deprecated. since 3.5 use isDisabled(String)

Description copied from interface: DeactivatedUserChecker

Determines if the specified user is deactivated.

Specified by:

isDeactivated in interface DeactivatedUserChecker

Parameters:

username - The username of the user

Returns:

true if the specified user is deactivated, false otherwise.

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(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.crowd.exception.UserNotFoundException

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.crowd.exception.UserNotFoundException - if the user does not exist

enableUser

public void enableUser(com.atlassian.crowd.embedded.api.User user)
                throws com.atlassian.crowd.exception.UserNotFoundException

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.crowd.exception.UserNotFoundException - if the user does not exist