DbCachingRemoteDirectory (Atlassian Crowd Core 5.0.7 API)

java.lang.Object
- com.atlassian.crowd.directory.AbstractForwardingDirectory
- - com.atlassian.crowd.directory.DbCachingRemoteDirectory

All Implemented Interfaces:

FastEntityCountProvider, MultiValuesQueriesSupport, RemoteDirectory, SynchronisableDirectory, Attributes
```
public class DbCachingRemoteDirectory
extends AbstractForwardingDirectory
implements RemoteDirectory, SynchronisableDirectory, FastEntityCountProvider, MultiValuesQueriesSupport
```
A RemoteDirectory that provides LDAP and Crowd integration plus local storage in an internal directory for LDAP user and group attributes, and local groups for LDAP and Crowd users with local caching of remote data. The implementation delegates to an Remote directory for the "source of truth" and an internal directory for caching and some special local storage.
All the attributes for the directory itself (e.g. base DN, other configuration options) are stored on the directory instance.
Terminology used in this class:

Remote user
A user stored in the LDAP or Remote Crowd directory

Remote group

A group stored in the LDAP or Remote Crowd directory.

Local group

A group stored in the internal directory. There must not be an Remote group with the same name for a local group to exist.

Constructor Summary

Constructors
Constructor and Description
`DbCachingRemoteDirectory(RemoteDirectory remoteDirectory, InternalRemoteDirectory internalDirectory, DirectoryCacheFactory directoryCacheFactory, CacheRefresherFactory cacheRefresherFactory, AuditService auditService, com.atlassian.crowd.manager.audit.mapper.AuditLogUserMapper auditLogUserMapper, String directoryName, com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.crowd.embedded.spi.DirectoryDao directoryDao, BatchConfigParser batchConfigParser)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Group`	`addGroup(GroupTemplate group)`
`void`	`addGroupToGroup(String childGroup, String parentGroup)`
`UserWithAttributes`	`addUser(UserTemplateWithAttributes user, PasswordCredential credential)`
`void`	`addUserToGroup(String username, String groupName)`
`User`	`authenticate(String name, PasswordCredential credential)`
`protected User`	`authenticateAndUpdateInternalUser(String name, PasswordCredential credential)` Authenticates user and ensures that internal directory contains the authenticated user.
`protected void`	`checkIfUserCanBeUpdatedWithCurrentGroupFiltering(String username, Set<String> userRemoteGroupNames)`
`void`	`expireAllPasswords()`
`RemoteDirectory`	`getAuthoritativeDirectory()`
`protected InternalRemoteDirectory`	`getDelegate()`
`String`	`getDescriptiveName()`
`long`	`getDirectoryId()`
`long`	`getGroupCount()`
`Set<String>`	`getKeys()`
`long`	`getUserCount()`
`String`	`getValue(String name)`
`Set<String>`	`getValues(String name)`
`boolean`	`isEmpty()`
`boolean`	`isIncrementalSyncEnabled()`
`boolean`	`isRolesDisabled()`
`void`	`removeGroup(String name)`
`void`	`removeGroupAttributes(String groupName, String attributeName)`
`void`	`removeGroupFromGroup(String childGroup, String parentGroup)`
`void`	`removeUser(String name)`
`void`	`removeUserAttributes(String username, String attributeName)`
`void`	`removeUserFromGroup(String username, String groupName)`
`Group`	`renameGroup(String oldName, String newName)`
`User`	`renameUser(String oldName, String newName)`
`<T> com.google.common.collect.ListMultimap<String,T>`	`searchGroupRelationshipsGroupedByName(MembershipQuery<T> query)`
`void`	`setAttributes(Map<String,String> attributes)`
`void`	`setDirectoryId(long directoryId)`
`protected boolean`	`shouldSyncGroupMembershipAfterUserAuthentication(boolean isNewUser)`
`void`	`storeGroupAttributes(String groupName, Map<String,Set<String>> attributes)`
`void`	`storeUserAttributes(String username, Map<String,Set<String>> attributes)`
`boolean`	`supportsInactiveAccounts()` This implementation will store the active flag locally in the internal directory if local user status is enabled and if the active flag cannot be persisted on the underlying remote directory.
`boolean`	`supportsNestedGroups()`
`boolean`	`supportsPasswordExpiration()`
`boolean`	`supportsSettingEncryptedCredential()`
`void`	`synchroniseCache(SynchronisationMode mode, SynchronisationStatusManager synchronisationStatusManager)`
`void`	`testConnection()`
`Group`	`updateGroup(GroupTemplate group)`
`protected void`	`updateGroupsMembershipOnLogin(User user, Set<String> userRemoteGroupNames)`
`User`	`updateUser(UserTemplate user)`
`protected User`	`updateUserAndSetActiveFlag(User remoteUser, User internalUser)`
`void`	`updateUserCredential(String username, PasswordCredential credential)`
`User`	`updateUserFromRemoteDirectory(User remoteUser)`
`User`	`userAuthenticated(String username)`

Methods inherited from class com.atlassian.crowd.directory.AbstractForwardingDirectory
addUser, countDirectMembersOfGroup, findGroupByName, findGroupWithAttributesByName, findUserByExternalId, findUserByName, findUserWithAttributesByName, getMemberships, getUserAvatarByName, isGroupDirectGroupMember, isUserDirectGroupMember, searchGroupRelationships, searchGroups, searchUsers

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.crowd.directory.RemoteDirectory
addUser, countDirectMembersOfGroup, findGroupByName, findGroupWithAttributesByName, findUserByExternalId, findUserByName, findUserWithAttributesByName, getLocallyFilteredGroupNames, getMemberships, getUserAvatarByName, isGroupDirectGroupMember, isUserDirectGroupMember, searchGroupRelationships, searchGroups, searchUsers

Methods inherited from interface com.atlassian.crowd.directory.MultiValuesQueriesSupport
searchGroupRelationships

Constructor Detail

DbCachingRemoteDirectory

public DbCachingRemoteDirectory(RemoteDirectory remoteDirectory,
                                InternalRemoteDirectory internalDirectory,
                                DirectoryCacheFactory directoryCacheFactory,
                                CacheRefresherFactory cacheRefresherFactory,
                                AuditService auditService,
                                com.atlassian.crowd.manager.audit.mapper.AuditLogUserMapper auditLogUserMapper,
                                String directoryName,
                                com.atlassian.event.api.EventPublisher eventPublisher,
                                com.atlassian.crowd.embedded.spi.DirectoryDao directoryDao,
                                BatchConfigParser batchConfigParser)

Method Detail

getDirectoryId
```
public long getDirectoryId()
```
Specified by:

getDirectoryId in interface RemoteDirectory

Overrides:

getDirectoryId in class AbstractForwardingDirectory

setDirectoryId
```
public void setDirectoryId(long directoryId)
```
Specified by:

setDirectoryId in interface RemoteDirectory

Overrides:

setDirectoryId in class AbstractForwardingDirectory

getDescriptiveName
```
public String getDescriptiveName()
```
Specified by:

getDescriptiveName in interface RemoteDirectory

Overrides:

getDescriptiveName in class AbstractForwardingDirectory

setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
Specified by:

setAttributes in interface RemoteDirectory

Overrides:

setAttributes in class AbstractForwardingDirectory

authenticate

public User authenticate(String name,
                         PasswordCredential credential)
                  throws UserNotFoundException,
                         InactiveAccountException,
                         InvalidAuthenticationException,
                         ExpiredCredentialException,
                         OperationFailedException

Specified by:: authenticate in interface RemoteDirectory
Overrides:: authenticate in class AbstractForwardingDirectory
Throws:: UserNotFoundException; InactiveAccountException; InvalidAuthenticationException; ExpiredCredentialException; OperationFailedException

authenticateAndUpdateInternalUser
```
protected User authenticateAndUpdateInternalUser(String name,
                                                 PasswordCredential credential)
                                          throws UserNotFoundException,
                                                 InactiveAccountException,
                                                 InvalidAuthenticationException,
                                                 ExpiredCredentialException,
                                                 OperationFailedException
```
Authenticates user and ensures that internal directory contains the authenticated user.
Updates user data (including groups membership) if the user exists in the internal directory. Renames user if necessary. If user does not exists tries to add the user and the user's memberships in the internal directory.
User might not exist in the internal directory yet because the user was added after the latest synchronisation. This happens for example when the remote directory uses delegated authentication, and creates users on successful authentication.

Parameters:

name - of the user

credential - credential of the user

Returns:

The populated user if the authentication is valid.

Throws:

UserNotFoundException - if the user does not exist

ExpiredCredentialException - if the password has expired and the user is required to change their password

InactiveAccountException - if the user account is not active

InvalidAuthenticationException - if the user name/password combination is invalid

OperationFailedException - if the operation failed for any other reason

updateUserFromRemoteDirectory

public User updateUserFromRemoteDirectory(@Nonnull
                                          User remoteUser)
                                   throws OperationFailedException,
                                          UserNotFoundException

Specified by:: updateUserFromRemoteDirectory in interface RemoteDirectory
Overrides:: updateUserFromRemoteDirectory in class AbstractForwardingDirectory
Throws:: OperationFailedException; UserNotFoundException

userAuthenticated

public User userAuthenticated(String username)
                       throws OperationFailedException,
                              UserNotFoundException,
                              InactiveAccountException

Specified by:: userAuthenticated in interface RemoteDirectory
Throws:: OperationFailedException; UserNotFoundException; InactiveAccountException

checkIfUserCanBeUpdatedWithCurrentGroupFiltering

protected void checkIfUserCanBeUpdatedWithCurrentGroupFiltering(String username,
                                                                Set<String> userRemoteGroupNames)
                                                         throws OperationFailedException,
                                                                UserNotFoundException

Throws:: OperationFailedException; UserNotFoundException

updateUserAndSetActiveFlag

protected User updateUserAndSetActiveFlag(User remoteUser,
                                          User internalUser)
                                   throws UserNotFoundException,
                                          InvalidUserException,
                                          OperationFailedException

Throws:: UserNotFoundException; InvalidUserException; OperationFailedException

updateGroupsMembershipOnLogin

protected void updateGroupsMembershipOnLogin(User user,
                                             Set<String> userRemoteGroupNames)
                                      throws OperationFailedException,
                                             UserNotFoundException

Throws:: OperationFailedException; UserNotFoundException

addUser

public UserWithAttributes addUser(UserTemplateWithAttributes user,
                                  PasswordCredential credential)
                           throws InvalidUserException,
                                  InvalidCredentialException,
                                  UserAlreadyExistsException,
                                  OperationFailedException

Specified by:: addUser in interface RemoteDirectory
Overrides:: addUser in class AbstractForwardingDirectory
Throws:: InvalidUserException; InvalidCredentialException; UserAlreadyExistsException; OperationFailedException

updateUser

public User updateUser(UserTemplate user)
                throws InvalidUserException,
                       UserNotFoundException,
                       OperationFailedException

Specified by:: updateUser in interface RemoteDirectory
Overrides:: updateUser in class AbstractForwardingDirectory
Throws:: InvalidUserException; UserNotFoundException; OperationFailedException

updateUserCredential

public void updateUserCredential(String username,
                                 PasswordCredential credential)
                          throws UserNotFoundException,
                                 InvalidCredentialException,
                                 OperationFailedException

Specified by:: updateUserCredential in interface RemoteDirectory
Overrides:: updateUserCredential in class AbstractForwardingDirectory
Throws:: UserNotFoundException; InvalidCredentialException; OperationFailedException

renameUser

public User renameUser(String oldName,
                       String newName)
                throws UserNotFoundException,
                       InvalidUserException,
                       OperationFailedException,
                       UserAlreadyExistsException

Specified by:: renameUser in interface RemoteDirectory
Overrides:: renameUser in class AbstractForwardingDirectory
Throws:: UserNotFoundException; InvalidUserException; OperationFailedException; UserAlreadyExistsException

storeUserAttributes

public void storeUserAttributes(String username,
                                Map<String,Set<String>> attributes)
                         throws UserNotFoundException,
                                OperationFailedException

Specified by:: storeUserAttributes in interface RemoteDirectory
Overrides:: storeUserAttributes in class AbstractForwardingDirectory
Throws:: UserNotFoundException; OperationFailedException

removeUserAttributes

public void removeUserAttributes(String username,
                                 String attributeName)
                          throws UserNotFoundException,
                                 OperationFailedException

Specified by:: removeUserAttributes in interface RemoteDirectory
Overrides:: removeUserAttributes in class AbstractForwardingDirectory
Throws:: UserNotFoundException; OperationFailedException

removeUser
```
public void removeUser(String name)
                throws UserNotFoundException,
                       OperationFailedException
```
Specified by:

removeUser in interface RemoteDirectory

Overrides:

removeUser in class AbstractForwardingDirectory

Throws:

UserNotFoundException

OperationFailedException

addGroup

public Group addGroup(GroupTemplate group)
               throws InvalidGroupException,
                      OperationFailedException

Specified by:: addGroup in interface RemoteDirectory
Overrides:: addGroup in class AbstractForwardingDirectory
Throws:: InvalidGroupException; OperationFailedException

updateGroup

public Group updateGroup(GroupTemplate group)
                  throws InvalidGroupException,
                         GroupNotFoundException,
                         OperationFailedException,
                         ReadOnlyGroupException

Specified by:: updateGroup in interface RemoteDirectory
Overrides:: updateGroup in class AbstractForwardingDirectory
Throws:: InvalidGroupException; GroupNotFoundException; OperationFailedException; ReadOnlyGroupException

renameGroup

public Group renameGroup(String oldName,
                         String newName)
                  throws GroupNotFoundException,
                         InvalidGroupException

Specified by:: renameGroup in interface RemoteDirectory
Overrides:: renameGroup in class AbstractForwardingDirectory
Throws:: GroupNotFoundException; InvalidGroupException

storeGroupAttributes

public void storeGroupAttributes(String groupName,
                                 Map<String,Set<String>> attributes)
                          throws GroupNotFoundException,
                                 OperationFailedException

Specified by:: storeGroupAttributes in interface RemoteDirectory
Overrides:: storeGroupAttributes in class AbstractForwardingDirectory
Throws:: GroupNotFoundException; OperationFailedException

removeGroupAttributes

public void removeGroupAttributes(String groupName,
                                  String attributeName)
                           throws GroupNotFoundException,
                                  OperationFailedException

Specified by:: removeGroupAttributes in interface RemoteDirectory
Overrides:: removeGroupAttributes in class AbstractForwardingDirectory
Throws:: GroupNotFoundException; OperationFailedException

removeGroup

public void removeGroup(String name)
                 throws GroupNotFoundException,
                        OperationFailedException,
                        ReadOnlyGroupException

Specified by:: removeGroup in interface RemoteDirectory
Overrides:: removeGroup in class AbstractForwardingDirectory
Throws:: GroupNotFoundException; OperationFailedException; ReadOnlyGroupException

addUserToGroup

public void addUserToGroup(String username,
                           String groupName)
                    throws GroupNotFoundException,
                           UserNotFoundException,
                           OperationFailedException,
                           ReadOnlyGroupException,
                           MembershipAlreadyExistsException

Specified by:: addUserToGroup in interface RemoteDirectory
Overrides:: addUserToGroup in class AbstractForwardingDirectory
Throws:: GroupNotFoundException; UserNotFoundException; OperationFailedException; ReadOnlyGroupException; MembershipAlreadyExistsException

addGroupToGroup

public void addGroupToGroup(String childGroup,
                            String parentGroup)
                     throws GroupNotFoundException,
                            InvalidMembershipException,
                            OperationFailedException,
                            ReadOnlyGroupException,
                            MembershipAlreadyExistsException

Specified by:: addGroupToGroup in interface RemoteDirectory
Overrides:: addGroupToGroup in class AbstractForwardingDirectory
Throws:: GroupNotFoundException; InvalidMembershipException; OperationFailedException; ReadOnlyGroupException; MembershipAlreadyExistsException

removeUserFromGroup

public void removeUserFromGroup(String username,
                                String groupName)
                         throws GroupNotFoundException,
                                UserNotFoundException,
                                MembershipNotFoundException,
                                OperationFailedException,
                                ReadOnlyGroupException

Specified by:: removeUserFromGroup in interface RemoteDirectory
Overrides:: removeUserFromGroup in class AbstractForwardingDirectory
Throws:: GroupNotFoundException; UserNotFoundException; MembershipNotFoundException; OperationFailedException; ReadOnlyGroupException

removeGroupFromGroup

public void removeGroupFromGroup(String childGroup,
                                 String parentGroup)
                          throws GroupNotFoundException,
                                 InvalidMembershipException,
                                 MembershipNotFoundException,
                                 OperationFailedException,
                                 ReadOnlyGroupException

Specified by:: removeGroupFromGroup in interface RemoteDirectory
Overrides:: removeGroupFromGroup in class AbstractForwardingDirectory
Throws:: GroupNotFoundException; InvalidMembershipException; MembershipNotFoundException; OperationFailedException; ReadOnlyGroupException

testConnection
```
public void testConnection()
                    throws OperationFailedException
```
Specified by:

testConnection in interface RemoteDirectory

Overrides:

testConnection in class AbstractForwardingDirectory

Throws:

OperationFailedException

supportsInactiveAccounts
```
public boolean supportsInactiveAccounts()
```
This implementation will store the active flag locally in the internal directory if local user status is enabled and if the active flag cannot be persisted on the underlying remote directory.

Specified by:

supportsInactiveAccounts in interface RemoteDirectory

Overrides:

supportsInactiveAccounts in class AbstractForwardingDirectory

Returns:

true if the internal directory supports inactive accounts (which it should always do).

supportsNestedGroups
```
public boolean supportsNestedGroups()
```
Specified by:

supportsNestedGroups in interface RemoteDirectory

Overrides:

supportsNestedGroups in class AbstractForwardingDirectory

supportsPasswordExpiration
```
public boolean supportsPasswordExpiration()
```
Specified by:

supportsPasswordExpiration in interface RemoteDirectory

Overrides:

supportsPasswordExpiration in class AbstractForwardingDirectory

supportsSettingEncryptedCredential
```
public boolean supportsSettingEncryptedCredential()
```
Specified by:

supportsSettingEncryptedCredential in interface RemoteDirectory

Overrides:

supportsSettingEncryptedCredential in class AbstractForwardingDirectory

isRolesDisabled
```
public boolean isRolesDisabled()
```
Specified by:

isRolesDisabled in interface RemoteDirectory

Overrides:

isRolesDisabled in class AbstractForwardingDirectory

shouldSyncGroupMembershipAfterUserAuthentication
```
protected boolean shouldSyncGroupMembershipAfterUserAuthentication(boolean isNewUser)
```
Parameters:

isNewUser - true if the user was created during authentication (ie. wasn't synced yet, and was created during this authentication)

Returns:

whether the user's group memberships should be synced during this authentication

See Also:

SynchronisableDirectoryProperties.SYNC_GROUP_MEMBERSHIP_AFTER_SUCCESSFUL_USER_AUTH_ENABLED

getValues
```
public Set<String> getValues(String name)
```
Specified by:

getValues in interface Attributes

Overrides:

getValues in class AbstractForwardingDirectory

getValue
```
public String getValue(String name)
```
Specified by:

getValue in interface Attributes

Overrides:

getValue in class AbstractForwardingDirectory

isEmpty
```
public boolean isEmpty()
```
Specified by:

isEmpty in interface Attributes

Overrides:

isEmpty in class AbstractForwardingDirectory

getKeys
```
public Set<String> getKeys()
```
Specified by:

getKeys in interface Attributes

Overrides:

getKeys in class AbstractForwardingDirectory

isIncrementalSyncEnabled
```
public boolean isIncrementalSyncEnabled()
```
Specified by:

isIncrementalSyncEnabled in interface SynchronisableDirectory

synchroniseCache

public void synchroniseCache(SynchronisationMode mode,
                             SynchronisationStatusManager synchronisationStatusManager)
                      throws OperationFailedException

Specified by:: synchroniseCache in interface SynchronisableDirectory
Throws:: OperationFailedException

getAuthoritativeDirectory
```
public RemoteDirectory getAuthoritativeDirectory()
```
Specified by:

getAuthoritativeDirectory in interface RemoteDirectory

Overrides:

getAuthoritativeDirectory in class AbstractForwardingDirectory

expireAllPasswords
```
public void expireAllPasswords()
                        throws OperationFailedException
```
Specified by:

expireAllPasswords in interface RemoteDirectory

Overrides:

expireAllPasswords in class AbstractForwardingDirectory

Throws:

OperationFailedException

getUserCount
```
public long getUserCount()
                  throws OperationFailedException
```
Specified by:

getUserCount in interface FastEntityCountProvider

Throws:

OperationFailedException

getGroupCount
```
public long getGroupCount()
                   throws OperationFailedException
```
Specified by:

getGroupCount in interface FastEntityCountProvider

Throws:

OperationFailedException

getDelegate
```
protected InternalRemoteDirectory getDelegate()
```
Specified by:

getDelegate in class AbstractForwardingDirectory

searchGroupRelationshipsGroupedByName

public <T> com.google.common.collect.ListMultimap<String,T> searchGroupRelationshipsGroupedByName(MembershipQuery<T> query)

Specified by:: searchGroupRelationshipsGroupedByName in interface MultiValuesQueriesSupport

Class DbCachingRemoteDirectory

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.crowd.directory.AbstractForwardingDirectory

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.crowd.directory.RemoteDirectory

Methods inherited from interface com.atlassian.crowd.directory.MultiValuesQueriesSupport

Constructor Detail

DbCachingRemoteDirectory

Method Detail

getDirectoryId

setDirectoryId

getDescriptiveName

setAttributes

authenticate

authenticateAndUpdateInternalUser

updateUserFromRemoteDirectory

userAuthenticated

checkIfUserCanBeUpdatedWithCurrentGroupFiltering

updateUserAndSetActiveFlag

updateGroupsMembershipOnLogin

addUser

updateUser

updateUserCredential

renameUser

storeUserAttributes

removeUserAttributes

removeUser

addGroup

updateGroup

renameGroup

storeGroupAttributes

removeGroupAttributes

removeGroup

addUserToGroup

addGroupToGroup

removeUserFromGroup

removeGroupFromGroup

testConnection

supportsInactiveAccounts

supportsNestedGroups

supportsPasswordExpiration

supportsSettingEncryptedCredential

isRolesDisabled

shouldSyncGroupMembershipAfterUserAuthentication

getValues

getValue

isEmpty

getKeys

isIncrementalSyncEnabled

synchroniseCache

getAuthoritativeDirectory

expireAllPasswords

getUserCount

getGroupCount

getDelegate

searchGroupRelationshipsGroupedByName