com.atlassian.crowd.directory

Enum SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth

java.lang.Object

java.lang.Enum<SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth>

com.atlassian.crowd.directory.SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth

All Implemented Interfaces:

Serializable, Comparable<SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth>

Enclosing class:

SynchronisableDirectoryProperties

public static enum SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth
extends Enum<SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth>

Allows configuring whether user groups should be synchronised when the user authenticates

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always sync group memberships during authentication - this was the default since 2.7, until 2.10 There is a potential performance impact on querying the groups on login, even if the list of memberships hasn't changed.
NEVER Never synchronize group memberships during authentication - this was the default before this feature was introduced in 2.7 (CWD-3429)
WHEN_AUTHENTICATION_CREATED_THE_USER Sync when the user has been created as a part of the authentication process, - this is the new default since 2.10 (CWD-4197).

Field Summary

Fields

Modifier and Type	Field and Description
static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth	DEFAULT This should be the default for new directories

Method Summary

Modifier and Type	Method and Description
static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth	forDirectory(Attributes directoryWithAttributes)
static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth	forValue(String attributeValue)
String	getValue()
static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth	valueOf(String name) Returns the enum constant of this type with the specified name.
static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth[]	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

NEVER

public static final SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth NEVER

Never synchronize group memberships during authentication - this was the default before this feature was introduced in 2.7 (CWD-3429)

ALWAYS

public static final SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth ALWAYS

Always sync group memberships during authentication - this was the default since 2.7, until 2.10 There is a potential performance impact on querying the groups on login, even if the list of memberships hasn't changed.

WHEN_AUTHENTICATION_CREATED_THE_USER

public static final SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth WHEN_AUTHENTICATION_CREATED_THE_USER

Sync when the user has been created as a part of the authentication process, - this is the new default since 2.10 (CWD-4197). This is a compromise between the convenience of being able to log in (and being in the right groups) without waiting for a sync, and allows for faster subsequent authentication.

Field Detail

DEFAULT

public static final SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth DEFAULT

This should be the default for new directories

Method Detail

values

public static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth[] 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 (SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth c : SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth.values())
    System.out.println(c);

Returns:

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

valueOf

public static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth 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

forDirectory

public static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth forDirectory(@Nonnull
                                                                                           Attributes directoryWithAttributes)

forValue

public static SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth forValue(String attributeValue)

getValue

public String getValue()