|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserManager
Simple user utilities that do not require an implementation with too many dependencies.
Method Summary | |
---|---|
boolean |
canDirectoryUpdateUserPassword(com.atlassian.crowd.embedded.api.Directory directory)
Checks if the given directory is able to update user passwords. |
boolean |
canUpdateGroupMembershipForUser(com.atlassian.crowd.embedded.api.User user)
Test if this user's group membership can be updated, i.e. |
boolean |
canUpdateUser(com.atlassian.crowd.embedded.api.User user)
Test if this user can be updated, i.e. |
boolean |
canUpdateUserPassword(com.atlassian.crowd.embedded.api.User user)
Test if this user's password can be updated, i.e. |
com.atlassian.crowd.embedded.api.User |
findUserInDirectory(String userName,
Long directoryId)
Returns a User based on user name and directoryId |
Set<com.atlassian.crowd.embedded.api.Group> |
getAllGroups()
Returns all groups defined in JIRA. |
Set<com.atlassian.crowd.embedded.api.User> |
getAllUsers()
Returns all users defined in JIRA, regardless of whether they are active or not. |
com.atlassian.crowd.embedded.api.Directory |
getDirectory(Long directoryId)
|
com.atlassian.crowd.embedded.api.Group |
getGroup(String groupName)
Returns a Group based on user name. |
com.atlassian.crowd.embedded.api.Group |
getGroupObject(String groupName)
Returns a Group based on user name. |
Collection<com.atlassian.crowd.embedded.api.Group> |
getGroups()
Returns all groups defined in JIRA. |
int |
getTotalUserCount()
Returns the total number of users defined in JIRA, regardless of whether they are active or not. |
com.atlassian.crowd.embedded.api.User |
getUser(String userName)
Returns a User based on user name. |
com.atlassian.crowd.embedded.api.User |
getUserEvenWhenUnknown(String userName)
Returns a User based on user name. |
com.atlassian.crowd.embedded.api.User |
getUserObject(String userName)
Returns a User based on user name. |
Collection<com.atlassian.crowd.embedded.api.User> |
getUsers()
Returns all users defined in JIRA, regardless of whether they are active or not. |
List<com.atlassian.crowd.embedded.api.Directory> |
getWritableDirectories()
Returns an ordered list of directories that have "read-write" permission. |
boolean |
hasGroupWritableDirectory()
Returns true if any of the directories have permission to update groups. |
boolean |
hasPasswordWritableDirectory()
Returns true if any of the directories have permission to update user passwords, false if otherwise. |
boolean |
hasWritableDirectory()
Returns true if at least one User Directory has "read-write" permission. |
void |
updateUser(com.atlassian.crowd.embedded.api.User user)
Updates the User . |
Method Detail |
---|
int getTotalUserCount()
@NotNull @IncompatibleReturnType(since="5.0", was="java.util.Set") Set<com.atlassian.crowd.embedded.api.User> getAllUsers()
com.opensymphony.user.User
. This class
has now been removed from the JIRA API, meaning that the 5.0 version is not binary or source compatible with
earlier versions.
@NotNull Collection<com.atlassian.crowd.embedded.api.User> getUsers()
getAllUsers()
.
getAllUsers()
@IncompatibleReturnType(since="5.0", was="com.opensymphony.user.User") com.atlassian.crowd.embedded.api.User getUser(@Nullable String userName)
User
based on user name.
Warning: previous incarnations of this method returned com.opensymphony.user.User
. This class
has now been removed from the JIRA API, meaning that the 5.0 version is not binary or source compatible with
earlier versions.
userName
- the user name of the user
com.atlassian.crowd.embedded.api.User getUserObject(@Nullable String userName)
User
based on user name.
Legacy synonym for getUser(String)
.
userName
- the user name of the user
getUser(String)
com.atlassian.crowd.embedded.api.User findUserInDirectory(String userName, Long directoryId)
User
based on user name and directoryId
userName
- the user name of the userdirectoryId
- the Directory to look in
com.atlassian.crowd.embedded.api.User getUserEvenWhenUnknown(String userName)
User
based on user name.
If a null username is passed, then a null User object is returned, but it is guaranteed to return a non-null User in all other cases.
If the username is not null, but the User is not found then a proxy unknown immutable User object is returned.
userName
- the user name of the user
boolean canUpdateUser(com.atlassian.crowd.embedded.api.User user)
If the "External user management" setting is on, then you cannot update the user.
user
- The user to update.
void updateUser(com.atlassian.crowd.embedded.api.User user)
User
. The user must have non-null names and email address.
user
- The user to update.
com.atlassian.crowd.exception.runtime.UserNotFoundException
- If the supplied user does not exist in the directory
.
com.atlassian.crowd.exception.runtime.OperationFailedException
- If the underlying directory implementation failed to execute the operation.boolean canUpdateUserPassword(com.atlassian.crowd.embedded.api.User user)
If the "External user management", or "External password management" setting is on, then you cannot update the password.
user
- The user to update.
boolean canUpdateGroupMembershipForUser(com.atlassian.crowd.embedded.api.User user)
user
- The user to update.
@IncompatibleReturnType(since="5.0", was="java.util.Set") Set<com.atlassian.crowd.embedded.api.Group> getAllGroups()
com.opensymphony.user.User
. This class
has now been removed from the JIRA API, meaning that the 5.0 version is not binary or source compatible with
earlier versions.
Collection<com.atlassian.crowd.embedded.api.Group> getGroups()
getAllGroups()
.
getAllGroups()
@IncompatibleReturnType(since="5.0", was="com.opensymphony.user.User") com.atlassian.crowd.embedded.api.Group getGroup(@Nullable String groupName)
Group
based on user name.
Warning: previous incarnations of this method returned com.opensymphony.user.User
. This class
has now been removed from the JIRA API, meaning that the 5.0 version is not binary or source compatible with
earlier versions.
groupName
- the user name of the group
com.atlassian.crowd.embedded.api.Group getGroupObject(@Nullable String groupName)
Group
based on user name.
Legacy synonym for getGroup(String)
.
groupName
- the user name of the group
getGroup(String)
List<com.atlassian.crowd.embedded.api.Directory> getWritableDirectories()
hasWritableDirectory()
boolean hasWritableDirectory()
This is equivalent to:
getWritableDirectories().size() > 0
getWritableDirectories()
,
hasPasswordWritableDirectory()
,
hasGroupWritableDirectory()
boolean hasPasswordWritableDirectory()
Note that this is not quite the same as hasWritableDirectory()
because of "Internal with LDAP Authentication" directories.
These directories are generally read-write but passwords are read-only.
hasWritableDirectory()
boolean hasGroupWritableDirectory()
Note that this will not always return the same results as hasWritableDirectory()
because you can set "Read-Only with Local Groups" to LDAP directories.
These directories are generally read-only but you can create local gropus and assign users to them.
hasWritableDirectory()
boolean canDirectoryUpdateUserPassword(com.atlassian.crowd.embedded.api.Directory directory)
directory
- the Directory
com.atlassian.crowd.embedded.api.Directory getDirectory(Long directoryId)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |