com.atlassian.confluence.it.usermanagement

Enum DirectoryConfigurationCapability

java.lang.Object

java.lang.Enum<DirectoryConfigurationCapability>

com.atlassian.confluence.it.usermanagement.DirectoryConfigurationCapability

All Implemented Interfaces:

Serializable, Comparable<DirectoryConfigurationCapability>

public enum DirectoryConfigurationCapability
extends Enum<DirectoryConfigurationCapability>

An enumeration of the capabilities of a particular configuration, as checked by DirectoryConfiguration.can(DirectoryConfigurationCapability).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE_EMPTY_GROUPS This configuration can create empty groups.
MODIFY_CONFIGURATION_IN_TESTS This configuration is suitable for running tests which changes the directory configuration via the UI.
MODIFY_LOCAL_LDAP_SERVER The LDAP server is local and can be modified directly via LdapUserManagementHelper.
MODIFY_USERS_VIA_UI This configuration allows the creation and removal of users through the UI.
RENAME_USERS Not all directories support user rename
RESET_PASSWORDS Confluence's password reset functionality works in this configuration.
SYNC_INCREMENTALLY Only a few directories support incremental synchronisation.
UPDATE_PASSWORDS It is possible to successfully update passwords on the server with this configuration.

Method Summary

Methods

Modifier and Type	Method and Description
static DirectoryConfigurationCapability	valueOf(String name) Returns the enum constant of this type with the specified name.
static DirectoryConfigurationCapability[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MODIFY_CONFIGURATION_IN_TESTS

public static final DirectoryConfigurationCapability MODIFY_CONFIGURATION_IN_TESTS

This configuration is suitable for running tests which changes the directory configuration via the UI. Most LDAP configurations shouldn't be modified in the tests, lest the changes prevent the administrator from being able to log in.

CREATE_EMPTY_GROUPS

public static final DirectoryConfigurationCapability CREATE_EMPTY_GROUPS

This configuration can create empty groups. Some LDAP servers can't.

UPDATE_PASSWORDS

public static final DirectoryConfigurationCapability UPDATE_PASSWORDS

It is possible to successfully update passwords on the server with this configuration.

On ApacheDS 1.0 in particular, you can't update passwords properly because the server caches them and never refreshes the cache.

RESET_PASSWORDS

public static final DirectoryConfigurationCapability RESET_PASSWORDS

Confluence's password reset functionality works in this configuration. Some LDAP servers have length restrictions on passwords which aren't met by our current password reset logic.

MODIFY_USERS_VIA_UI

public static final DirectoryConfigurationCapability MODIFY_USERS_VIA_UI

This configuration allows the creation and removal of users through the UI. This should be the case if there at least one read-write directory configured.

MODIFY_LOCAL_LDAP_SERVER

public static final DirectoryConfigurationCapability MODIFY_LOCAL_LDAP_SERVER

The LDAP server is local and can be modified directly via LdapUserManagementHelper.

RENAME_USERS

public static final DirectoryConfigurationCapability RENAME_USERS

Not all directories support user rename

SYNC_INCREMENTALLY

public static final DirectoryConfigurationCapability SYNC_INCREMENTALLY

Only a few directories support incremental synchronisation.

Method Detail

values

public static DirectoryConfigurationCapability[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DirectoryConfigurationCapability c : DirectoryConfigurationCapability.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DirectoryConfigurationCapability valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null