Class UsersSoapService
java.lang.Object
com.atlassian.confluence.rpc.soap.services.UsersSoapService
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Adds the specified group.boolean
addProfilePicture
(String userName, String fileName, String mimeType, byte[] pictureData) Add a profile picture to a user's profileboolean
addUser
(RemoteUser user, String password, boolean notifyUser) Adds user.boolean
addUserToGroup
(String username, String groupname) Add user to the specified group.boolean
changeMyPassword
(String token, String oldPass, String newPass) Changes your password.boolean
changeUserPassword
(String username, String newPass) Changes the user's password.boolean
deactivateUser
(String username) Deactivates the specified user.boolean
editUser
(RemoteUser remoteUser) Allows the email and the fullname of a user to be edited by specifying these values in the passed inRemoteUser
.String[]
getActiveUsers
(boolean viewAll) String[]
Returns all groups.getUserByKey
(String userKey) getUserByName
(String username) String[]
getUserGroups
(String username) Fetches the groups that the specified user belongs to.getUserInformation
(String username) boolean
getUserPreferenceBoolean
(String username, String key) long
getUserPreferenceLong
(String username, String key) getUserPreferenceString
(String username, String key) boolean
boolean
boolean
isActiveUser
(String username) boolean
reactivateUser
(String username) boolean
removeAllPermissionsForGroup
(String groupname) Delete all permissions (global and space level) permissions for the group with the given name.boolean
removeGroup
(String groupName, String moveToGroupName) Delete group with name groupname.boolean
removeUser
(String username) Delete the given user from the Confluence System.boolean
removeUserFromGroup
(String username, String groupname) Delete the user with name username from the group with name groupname.boolean
renameUser
(String oldUsername, String newUsername) String[]
renameUsers
(Map<String, String> oldUsernamesToNewUsernames) Renames multiple users at the same time.void
setAttachmentManager
(AttachmentManager attachmentManager) void
setEventPublisher
(com.atlassian.event.api.EventPublisher eventPublisher) void
setLoginManager
(LoginManager loginManager) void
setPermissionManager
(PermissionManager permissionManager) void
setPersonalInformationManager
(PersonalInformationManager personalInformationManager) void
setSoapServiceHelper
(SoapServiceHelper soapServiceHelper) void
setSpaceManager
(SpaceManager spaceManager) void
setSpacePermissionManager
(SpacePermissionManager spacePermissionManager) void
setTokenAuthenticationManager
(TokenAuthenticationManager tokenAuthenticationManager) void
setUserAccessor
(UserAccessor userAccessor) boolean
setUserInformation
(RemoteUserInformation userInfo) boolean
setUserPreferenceBoolean
(String username, String key, boolean value) boolean
setUserPreferenceLong
(String username, String key, long value) boolean
setUserPreferenceString
(String username, String key, String value)
-
Constructor Details
-
UsersSoapService
public UsersSoapService()
-
-
Method Details
-
setAttachmentManager
-
setUserAccessor
-
setSpacePermissionManager
-
setSoapServiceHelper
-
setSpaceManager
-
setPermissionManager
-
setEventPublisher
public void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher) -
setLoginManager
-
setTokenAuthenticationManager
-
getUserByName
- Throws:
RemoteException
- Since:
- 5.2
-
getUserByKey
- Throws:
RemoteException
- Since:
- 5.2
-
addUser
Adds user.- Throws:
NotPermittedException
- if you do not have permissions to add the user.RemoteException
-
removeUser
Delete the given user from the Confluence System.- Parameters:
username
- is the name of the user that is to be deleted from the CONFLUENCE SYSTEM.- Throws:
RemoteException
- if the specified user has authored content. You cannot remove users that have authored content.NotPermittedException
- if you do not have permissions to remove the user
-
editUser
Allows the email and the fullname of a user to be edited by specifying these values in the passed inRemoteUser
.- Throws:
NotPermittedException
- if you do not have permissions to edit this userRemoteException
- if the no user found with the name specified in remoteUser
-
getUserGroups
Fetches the groups that the specified user belongs to.- Returns:
- an array of the groups that this user belongs to as
String
's - Throws:
RemoteException
- if the no user found with the name specified in remoteUser
-
addUserToGroup
Add user to the specified group.- Throws:
RemoteException
- if the user or group does not existNotPermittedException
- if you do have permissions to modify the group and hence add members to it
-
removeUserFromGroup
Delete the user with name username from the group with name groupname.- Parameters:
username
- is the name of the user that is to be deleted from the group with wih name groupname.groupname
- is the name of the group from which the user with name username is to be deleted.- Throws:
RemoteException
- if user/group with the given names does not existNotPermittedException
- if you do not have permissions to remove the user from the specified group
-
addGroup
Adds the specified group. Group will not be created if it already exists.- Throws:
NotPermittedException
- if you do not have permissions to add groups.RemoteException
-
removeAllPermissionsForGroup
Delete all permissions (global and space level) permissions for the group with the given name.- Parameters:
groupname
- is the group for which all the permissions has to be deleted- Returns:
- true if all permisisons were successfully removed from this group, false otherwise.
- Throws:
RemoteException
- if group with the given name does not existNotPermittedException
- if you do not have permissions to remove all permissions from this group
-
removeGroup
Delete group with name groupname. If moveToGroupName group is specified, members of the deleted group will be moved to it.- Parameters:
groupName
- is the group that is to be deletedmoveToGroupName
- moves members of deleted group to here- Throws:
RemoteException
- if either group does not existNotPermittedException
- if the current logged in user either does not have permission to remove the group, or modify the group to move members to
-
getGroups
Returns all groups.- Throws:
RemoteException
- if you are not allowed to retrieve all groups
-
deactivateUser
Deactivates the specified user.- Throws:
NotPermittedException
- if you do not have permissions to set permissions on the specified userRemoteException
- if user has already been deactivated.
-
reactivateUser
- Throws:
RemoteException
-
isActiveUser
- Throws:
RemoteException
-
getActiveUsers
- Throws:
RemoteException
-
changeMyPassword
public boolean changeMyPassword(String token, String oldPass, String newPass) throws RemoteException Changes your password.- Parameters:
newPass
- must not be null or empty string- Throws:
NotPermittedException
RemoteException
- if the new password is null or empty
-
changeUserPassword
Changes the user's password.- Parameters:
newPass
- must not be null or empty string- Throws:
NotPermittedException
RemoteException
-
setUserInformation
- Throws:
RemoteException
-
getUserInformation
- Throws:
RemoteException
-
setUserPreferenceBoolean
public boolean setUserPreferenceBoolean(String username, String key, boolean value) throws RemoteException - Throws:
RemoteException
-
getUserPreferenceBoolean
- Throws:
RemoteException
-
setUserPreferenceLong
public boolean setUserPreferenceLong(String username, String key, long value) throws RemoteException - Throws:
RemoteException
-
getUserPreferenceLong
- Throws:
RemoteException
-
setUserPreferenceString
public boolean setUserPreferenceString(String username, String key, String value) throws RemoteException - Throws:
RemoteException
-
getUserPreferenceString
- Throws:
RemoteException
-
hasUser
-
hasGroup
- Throws:
NotPermittedException
-
setPersonalInformationManager
-
addProfilePicture
public boolean addProfilePicture(String userName, String fileName, String mimeType, byte[] pictureData) throws RemoteException Add a profile picture to a user's profile- Parameters:
userName
- The user name of the profilefileName
- File name of the picturemimeType
- Image mime type (must be from image/*)pictureData
- The image data- Returns:
- true if successful
- Throws:
RemoteException
-
renameUser
- Throws:
RemoteException
-
renameUsers
Renames multiple users at the same time.- Parameters:
oldUsernamesToNewUsernames
- key value pairs where old username is the key and new username is the value- Returns:
- usernames of users that could not be renamed
-