Package com.atlassian.crowd.directory

Class SynchronisableDirectoryProperties

java.lang.Object

com.atlassian.crowd.directory.SynchronisableDirectoryProperties

public class SynchronisableDirectoryProperties
extends Object

Constants representing synchronisable directory properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth	Allows configuring whether user groups should be synchronised when the user authenticates

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_SYNCHRONISATION_TYPE	Property key for chosen cache synchronisation type.
static final String	CACHE_SYNCHRONISE_CRON	Property key for the cron expression specifying when the local cache should be synchronised with the remote directory.
static final String	CACHE_SYNCHRONISE_INTERVAL	Property key for the interval in seconds when the local cache should be synchronised with the remote directory.
static final String	CONNECTION_TIMEOUT_IN_MILLISECONDS	Timeout stored in milliseconds when opening new server connections.
static final String	CURRENT_START_SYNC_TIME	Deprecated. since 2.12.0, use SynchronisationStatusManager instead
static final String	INCREMENTAL_SYNC_ENABLED	Property key for enabling incremental sync
static final String	IS_SYNCHRONISING	Deprecated. since 2.12.0, use SynchronisationStatusManager instead
static final String	LAST_START_SYNC_TIME	Deprecated. since 2.12.0, use SynchronisationStatusManager instead
static final String	LAST_SYNC_DURATION_MS	Deprecated. since 2.12.0, use SynchronisationStatusManager instead
static final String	READ_TIMEOUT_IN_MILLISECONDS	Timeout stored in milliseconds for search and other read operations.
static final String	SYNC_GROUP_MEMBERSHIP_AFTER_SUCCESSFUL_USER_AUTH_ENABLED	Property key for controlling group membership sync after successful user auth.
static final String	SYNC_USER_FILTER_CQL	Property key for syncing a subset of users for a SynchronisableDirectory, as long as SynchronisationMode.FULL is the only mode being used.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

CURRENT_START_SYNC_TIME

@Deprecated
public static final String CURRENT_START_SYNC_TIME

Deprecated.

since 2.12.0, use SynchronisationStatusManager instead

Property key for the current synchronisation's start time in milliseconds from epoch.

See Also:

• Constant Field Values

LAST_START_SYNC_TIME

@Deprecated
public static final String LAST_START_SYNC_TIME

Deprecated.

since 2.12.0, use SynchronisationStatusManager instead

Property key for the last synchronisation's start time in milliseconds from epoch.

See Also:

• Constant Field Values

LAST_SYNC_DURATION_MS

@Deprecated
public static final String LAST_SYNC_DURATION_MS

Deprecated.

since 2.12.0, use SynchronisationStatusManager instead

Property key for the last synchronisation's duration in milliseconds.

See Also:

• Constant Field Values

CACHE_SYNCHRONISE_INTERVAL

public static final String CACHE_SYNCHRONISE_INTERVAL

Property key for the interval in seconds when the local cache should be synchronised with the remote directory.

See Also:

• Constant Field Values

CACHE_SYNCHRONISE_CRON

public static final String CACHE_SYNCHRONISE_CRON

Property key for the cron expression specifying when the local cache should be synchronised with the remote directory.

See Also:

• Constant Field Values

CACHE_SYNCHRONISATION_TYPE

public static final String CACHE_SYNCHRONISATION_TYPE

Property key for chosen cache synchronisation type.

See Also:

• Constant Field Values

IS_SYNCHRONISING

@Deprecated
public static final String IS_SYNCHRONISING

Deprecated.

since 2.12.0, use SynchronisationStatusManager instead

Property key for the synchronisation status.

This property should be unset before the first synchronisation has started after directory creation or configuration change.

See Also:

• Constant Field Values

INCREMENTAL_SYNC_ENABLED

public static final String INCREMENTAL_SYNC_ENABLED

Property key for enabling incremental sync

See Also:

• Constant Field Values

SYNC_USER_FILTER_CQL

public static final String SYNC_USER_FILTER_CQL

Property key for syncing a subset of users for a SynchronisableDirectory, as long as SynchronisationMode.FULL is the only mode being used. The value of the attribute with this key must be CQL and is used to filter remote users: only users which match the CQL will be synchronised to the directory. Setting this property on a directory of type other than SynchronisableDirectory should have no effect. Setting this property when SynchronisationMode.FULL is not the only mode being used will result in undefined behaviour. Setting this property as a Java system property is equivalent to setting it on every synchronisable directory. If set as both a Java system property and on the directory, then the Java system property will take precedence.

See Also:

• Constant Field Values

SYNC_GROUP_MEMBERSHIP_AFTER_SUCCESSFUL_USER_AUTH_ENABLED

public static final String SYNC_GROUP_MEMBERSHIP_AFTER_SUCCESSFUL_USER_AUTH_ENABLED

Property key for controlling group membership sync after successful user auth. This operation can slow down user auth check significantly if the directory contains lots of groups. In that case, Crowd admin might want to disable this feature and rely on scheduled or manual directory sync to update the group membership details for the affected users. Possible values are managed by SynchronisableDirectoryProperties.SyncGroupMembershipsAfterAuth

See Also:

• Constant Field Values

CONNECTION_TIMEOUT_IN_MILLISECONDS

public static final String CONNECTION_TIMEOUT_IN_MILLISECONDS

Timeout stored in milliseconds when opening new server connections. While the property name refers to LDAP, this property is also used by non-LDAP directories eg. Microsoft Entra ID When connection pooling has been requested, this property also specifies the maximum wait time for a connection when all connections in pool are in use and the maximum pool size has been reached. Default: 0

See Also:

• Constant Field Values

READ_TIMEOUT_IN_MILLISECONDS

public static final String READ_TIMEOUT_IN_MILLISECONDS

Timeout stored in milliseconds for search and other read operations. Default: 120 seconds (120000ms). While the property name refers to LDAP, this property is also used by non-LDAP directories eg. Microsoft Entra ID

Warning: CWD-2494: When read timeout is enabled, LDAP operations can fail randomly with "javax.naming.NamingException: LDAP response read timed out..." error message without waiting for the timeout to pass.

See Also:

• Constant Field Values