com.atlassian.crowd.manager.recovery
Class RecoveryModeRemoteDirectory
java.lang.Object
com.atlassian.crowd.manager.recovery.RecoveryModeRemoteDirectory
- All Implemented Interfaces:
- RemoteDirectory, Attributes
public class RecoveryModeRemoteDirectory
- extends Object
- implements RemoteDirectory
Proxy directory that adds a temp admin account to Crowd and allow admin to login to recover from a broken deployment.
In case of a broken deployment or if the remote directory is down, the crowd admin will not be able to login to Crowd
if it's account info is stored in that remote directory.
In this case, sysops can enable this "Proxy" directory, which essentially adds a new directory contains an admin user
with a customisable password, and let the crowd admin to login to crowd and fix the deployment issue.
|
Method Summary |
Group |
addGroup(GroupTemplate group)
|
void |
addGroupToGroup(String childGroup,
String parentGroup)
|
User |
addUser(UserTemplate user,
PasswordCredential credential)
|
void |
addUserToGroup(String username,
String groupName)
|
User |
authenticate(String name,
PasswordCredential credential)
|
BoundedCount |
countDirectMembersOfGroup(String groupName,
int querySizeHint)
|
void |
expireAllPasswords()
|
Group |
findGroupByName(String name)
|
GroupWithAttributes |
findGroupWithAttributesByName(String name)
|
User |
findUserByExternalId(String externalId)
|
User |
findUserByName(String name)
|
UserWithAttributes |
findUserWithAttributesByName(String name)
|
RemoteDirectory |
getAuthoritativeDirectory()
|
String |
getDescriptiveName()
|
long |
getDirectoryId()
|
Set<String> |
getKeys()
|
Iterable<Membership> |
getMemberships()
|
String |
getValue(String key)
|
Set<String> |
getValues(String key)
|
boolean |
isEmpty()
|
boolean |
isGroupDirectGroupMember(String childGroup,
String parentGroup)
|
boolean |
isRolesDisabled()
|
boolean |
isUserDirectGroupMember(String username,
String groupName)
|
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)
|
|
searchGroupRelationships(MembershipQuery<T> query)
|
|
searchGroups(EntityQuery<T> query)
|
|
searchUsers(EntityQuery<T> query)
|
void |
setAttributes(Map<String,String> attributes)
|
void |
setDirectoryId(long directoryId)
|
void |
storeGroupAttributes(String groupName,
Map<String,Set<String>> attributes)
|
void |
storeUserAttributes(String username,
Map<String,Set<String>> attributes)
|
boolean |
supportsInactiveAccounts()
|
boolean |
supportsNestedGroups()
|
boolean |
supportsPasswordExpiration()
Does not support expiring passwords |
boolean |
supportsSettingEncryptedCredential()
|
void |
testConnection()
|
Group |
updateGroup(GroupTemplate group)
|
User |
updateUser(UserTemplate user)
|
void |
updateUserCredential(String username,
PasswordCredential credential)
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
RecoveryModeRemoteDirectory
public RecoveryModeRemoteDirectory(com.atlassian.crowd.manager.recovery.RecoveryModeDirectory directory)
getDirectoryId
public long getDirectoryId()
- Specified by:
getDirectoryId in interface RemoteDirectory
setDirectoryId
public void setDirectoryId(long directoryId)
- Specified by:
setDirectoryId in interface RemoteDirectory
getDescriptiveName
public String getDescriptiveName()
- Specified by:
getDescriptiveName in interface RemoteDirectory
setAttributes
public void setAttributes(Map<String,String> attributes)
- Specified by:
setAttributes in interface RemoteDirectory
authenticate
public User authenticate(String name,
PasswordCredential credential)
throws UserNotFoundException,
InactiveAccountException,
InvalidAuthenticationException,
ExpiredCredentialException,
OperationFailedException
- Specified by:
authenticate in interface RemoteDirectory
- Throws:
UserNotFoundException
InactiveAccountException
InvalidAuthenticationException
ExpiredCredentialException
OperationFailedException
findUserByName
public User findUserByName(String name)
throws UserNotFoundException,
OperationFailedException
- Specified by:
findUserByName in interface RemoteDirectory
- Throws:
UserNotFoundException
OperationFailedException
findUserWithAttributesByName
public UserWithAttributes findUserWithAttributesByName(String name)
throws UserNotFoundException,
OperationFailedException
- Specified by:
findUserWithAttributesByName in interface RemoteDirectory
- Throws:
UserNotFoundException
OperationFailedException
findUserByExternalId
public User findUserByExternalId(String externalId)
throws UserNotFoundException,
OperationFailedException
- Specified by:
findUserByExternalId in interface RemoteDirectory
- Throws:
UserNotFoundException
OperationFailedException
addUser
public User addUser(UserTemplate user,
PasswordCredential credential)
throws InvalidUserException,
InvalidCredentialException,
UserAlreadyExistsException,
OperationFailedException
- Specified by:
addUser in interface RemoteDirectory
- Throws:
InvalidUserException
InvalidCredentialException
UserAlreadyExistsException
OperationFailedException
updateUser
public User updateUser(UserTemplate user)
throws InvalidUserException,
UserNotFoundException,
OperationFailedException
- Specified by:
updateUser in interface RemoteDirectory
- Throws:
InvalidUserException
UserNotFoundException
OperationFailedException
updateUserCredential
public void updateUserCredential(String username,
PasswordCredential credential)
throws UserNotFoundException,
InvalidCredentialException,
OperationFailedException
- Specified by:
updateUserCredential in interface RemoteDirectory
- Throws:
UserNotFoundException
InvalidCredentialException
OperationFailedException
renameUser
public User renameUser(String oldName,
String newName)
throws UserNotFoundException,
InvalidUserException,
UserAlreadyExistsException,
OperationFailedException
- Specified by:
renameUser in interface RemoteDirectory
- Throws:
UserNotFoundException
InvalidUserException
UserAlreadyExistsException
OperationFailedException
storeUserAttributes
public void storeUserAttributes(String username,
Map<String,Set<String>> attributes)
throws UserNotFoundException,
OperationFailedException
- Specified by:
storeUserAttributes in interface RemoteDirectory
- Throws:
UserNotFoundException
OperationFailedException
removeUserAttributes
public void removeUserAttributes(String username,
String attributeName)
throws UserNotFoundException,
OperationFailedException
- Specified by:
removeUserAttributes in interface RemoteDirectory
- Throws:
UserNotFoundException
OperationFailedException
removeUser
public void removeUser(String name)
throws UserNotFoundException,
OperationFailedException
- Specified by:
removeUser in interface RemoteDirectory
- Throws:
UserNotFoundException
OperationFailedException
searchUsers
public <T> List<T> searchUsers(EntityQuery<T> query)
throws OperationFailedException
- Specified by:
searchUsers in interface RemoteDirectory
- Throws:
OperationFailedException
findGroupByName
public Group findGroupByName(String name)
throws GroupNotFoundException,
OperationFailedException
- Specified by:
findGroupByName in interface RemoteDirectory
- Throws:
GroupNotFoundException
OperationFailedException
findGroupWithAttributesByName
public GroupWithAttributes findGroupWithAttributesByName(String name)
throws GroupNotFoundException,
OperationFailedException
- Specified by:
findGroupWithAttributesByName in interface RemoteDirectory
- Throws:
GroupNotFoundException
OperationFailedException
addGroup
public Group addGroup(GroupTemplate group)
throws InvalidGroupException,
OperationFailedException
- Specified by:
addGroup in interface RemoteDirectory
- Throws:
InvalidGroupException
OperationFailedException
updateGroup
public Group updateGroup(GroupTemplate group)
throws InvalidGroupException,
GroupNotFoundException,
ReadOnlyGroupException,
OperationFailedException
- Specified by:
updateGroup in interface RemoteDirectory
- Throws:
InvalidGroupException
GroupNotFoundException
ReadOnlyGroupException
OperationFailedException
renameGroup
public Group renameGroup(String oldName,
String newName)
throws GroupNotFoundException,
InvalidGroupException,
OperationFailedException
- Specified by:
renameGroup in interface RemoteDirectory
- Throws:
GroupNotFoundException
InvalidGroupException
OperationFailedException
storeGroupAttributes
public void storeGroupAttributes(String groupName,
Map<String,Set<String>> attributes)
throws GroupNotFoundException,
OperationFailedException
- Specified by:
storeGroupAttributes in interface RemoteDirectory
- Throws:
GroupNotFoundException
OperationFailedException
removeGroupAttributes
public void removeGroupAttributes(String groupName,
String attributeName)
throws GroupNotFoundException,
OperationFailedException
- Specified by:
removeGroupAttributes in interface RemoteDirectory
- Throws:
GroupNotFoundException
OperationFailedException
removeGroup
public void removeGroup(String name)
throws GroupNotFoundException,
ReadOnlyGroupException,
OperationFailedException
- Specified by:
removeGroup in interface RemoteDirectory
- Throws:
GroupNotFoundException
ReadOnlyGroupException
OperationFailedException
searchGroups
public <T> List<T> searchGroups(EntityQuery<T> query)
throws OperationFailedException
- Specified by:
searchGroups in interface RemoteDirectory
- Throws:
OperationFailedException
isUserDirectGroupMember
public boolean isUserDirectGroupMember(String username,
String groupName)
throws OperationFailedException
- Specified by:
isUserDirectGroupMember in interface RemoteDirectory
- Throws:
OperationFailedException
isGroupDirectGroupMember
public boolean isGroupDirectGroupMember(String childGroup,
String parentGroup)
throws OperationFailedException
- Specified by:
isGroupDirectGroupMember in interface RemoteDirectory
- Throws:
OperationFailedException
countDirectMembersOfGroup
public BoundedCount countDirectMembersOfGroup(String groupName,
int querySizeHint)
throws OperationFailedException
- Specified by:
countDirectMembersOfGroup in interface RemoteDirectory
- Throws:
OperationFailedException
addUserToGroup
public void addUserToGroup(String username,
String groupName)
throws GroupNotFoundException,
UserNotFoundException,
ReadOnlyGroupException,
OperationFailedException,
MembershipAlreadyExistsException
- Specified by:
addUserToGroup in interface RemoteDirectory
- Throws:
GroupNotFoundException
UserNotFoundException
ReadOnlyGroupException
OperationFailedException
MembershipAlreadyExistsException
addGroupToGroup
public void addGroupToGroup(String childGroup,
String parentGroup)
throws GroupNotFoundException,
InvalidMembershipException,
ReadOnlyGroupException,
OperationFailedException,
MembershipAlreadyExistsException
- Specified by:
addGroupToGroup in interface RemoteDirectory
- Throws:
GroupNotFoundException
InvalidMembershipException
ReadOnlyGroupException
OperationFailedException
MembershipAlreadyExistsException
removeUserFromGroup
public void removeUserFromGroup(String username,
String groupName)
throws GroupNotFoundException,
UserNotFoundException,
MembershipNotFoundException,
ReadOnlyGroupException,
OperationFailedException
- Specified by:
removeUserFromGroup in interface RemoteDirectory
- Throws:
GroupNotFoundException
UserNotFoundException
MembershipNotFoundException
ReadOnlyGroupException
OperationFailedException
removeGroupFromGroup
public void removeGroupFromGroup(String childGroup,
String parentGroup)
throws GroupNotFoundException,
InvalidMembershipException,
MembershipNotFoundException,
ReadOnlyGroupException,
OperationFailedException
- Specified by:
removeGroupFromGroup in interface RemoteDirectory
- Throws:
GroupNotFoundException
InvalidMembershipException
MembershipNotFoundException
ReadOnlyGroupException
OperationFailedException
expireAllPasswords
public void expireAllPasswords()
throws OperationFailedException
- Specified by:
expireAllPasswords in interface RemoteDirectory
- Throws:
OperationFailedException
searchGroupRelationships
public <T> List<T> searchGroupRelationships(MembershipQuery<T> query)
throws OperationFailedException
- Specified by:
searchGroupRelationships in interface RemoteDirectory
- Throws:
OperationFailedException
testConnection
public void testConnection()
throws OperationFailedException
- Specified by:
testConnection in interface RemoteDirectory
- Throws:
OperationFailedException
supportsInactiveAccounts
public boolean supportsInactiveAccounts()
- Specified by:
supportsInactiveAccounts in interface RemoteDirectory
supportsNestedGroups
public boolean supportsNestedGroups()
- Specified by:
supportsNestedGroups in interface RemoteDirectory
supportsPasswordExpiration
public boolean supportsPasswordExpiration()
- Does not support expiring passwords
- Specified by:
supportsPasswordExpiration in interface RemoteDirectory
- Returns:
false, always
supportsSettingEncryptedCredential
public boolean supportsSettingEncryptedCredential()
- Specified by:
supportsSettingEncryptedCredential in interface RemoteDirectory
isRolesDisabled
public boolean isRolesDisabled()
- Specified by:
isRolesDisabled in interface RemoteDirectory
getMemberships
public Iterable<Membership> getMemberships()
throws OperationFailedException
- Specified by:
getMemberships in interface RemoteDirectory
- Throws:
OperationFailedException
getAuthoritativeDirectory
public RemoteDirectory getAuthoritativeDirectory()
- Specified by:
getAuthoritativeDirectory in interface RemoteDirectory
getValues
public Set<String> getValues(String key)
- Specified by:
getValues in interface Attributes
getValue
public String getValue(String key)
- Specified by:
getValue in interface Attributes
getKeys
public Set<String> getKeys()
- Specified by:
getKeys in interface Attributes
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty in interface Attributes
Copyright © 2016 Atlassian. All Rights Reserved.