|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.crowd.plugin.rest.service.resource.AbstractResource com.atlassian.crowd.plugin.rest.service.resource.UsersResource
public class UsersResource
Field Summary |
---|
Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource |
---|
DEFAULT_SEARCH_RESULT_SIZE, MAX_RESULTS_PARAM, request, START_INDEX_PARAM, uriInfo |
Constructor Summary | |
---|---|
UsersResource(UsersController usersController)
|
Method Summary | |
---|---|
javax.ws.rs.core.Response |
addUser(UserEntity userEntity)
Adds a new user. |
javax.ws.rs.core.Response |
addUserToGroup(String userName,
GroupEntity parentGroup)
Adds a user to a group. |
javax.ws.rs.core.Response |
getDirectGroups(String userName,
String groupName,
int maxResults,
int startIndex)
Returns the direct group(s) of the user. |
javax.ws.rs.core.Response |
getNestedGroups(String userName,
String groupName,
int maxResults,
int startIndex)
Returns the nested group(s) of the user. |
javax.ws.rs.core.Response |
getUser(String userName)
Retrieves the user. |
javax.ws.rs.core.Response |
getUserAttributes(String userName)
Retrieves the user attributes. |
javax.ws.rs.core.Response |
removeUser(String userName)
Removes a user. |
javax.ws.rs.core.Response |
removeUserAttribute(String userName,
String attributeName)
Deletes a user attribute. |
javax.ws.rs.core.Response |
removeUserFromGroup(String userName,
String groupName)
Removes a user from a group. |
javax.ws.rs.core.Response |
requestPasswordReset(String userName)
Requests a password reset. |
javax.ws.rs.core.Response |
requestUsernames(String email)
Requests an email to be sent containing usernames associated with the given email address. |
javax.ws.rs.core.Response |
storeUserAttributes(String userName,
MultiValuedAttributeEntityList attributes)
Stores the user attributes. |
javax.ws.rs.core.Response |
updateUser(String userName,
UserEntity userEntity)
Updates a user. |
javax.ws.rs.core.Response |
updateUserPassword(String userName,
PasswordEntity password)
Updates a user password. |
Methods inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource |
---|
getApplicationName, getBaseUri |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UsersResource(UsersController usersController)
Method Detail |
---|
public javax.ws.rs.core.Response getUser(String userName) throws UserNotFoundException
userName
- name of the user.
UserNotFoundException
public javax.ws.rs.core.Response addUser(UserEntity userEntity) throws InvalidUserException, InvalidCredentialException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userEntity
- the user to create
InvalidUserException
InvalidCredentialException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response updateUser(String userName, UserEntity userEntity) throws InvalidUserException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the user to updateuserEntity
- the user to create
InvalidUserException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response removeUser(String userName) throws UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the user to delete
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response getUserAttributes(String userName) throws UserNotFoundException
userName
- name of the user.
UserNotFoundException
public javax.ws.rs.core.Response storeUserAttributes(String userName, MultiValuedAttributeEntityList attributes) throws UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the userattributes
- new attributes of the user
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response removeUserAttribute(String userName, String attributeName) throws UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the userattributeName
- name of the attribute to delete
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response updateUserPassword(String userName, PasswordEntity password) throws InvalidCredentialException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- the name of the user to update the password forpassword
- the password to set against the user
InvalidCredentialException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response requestPasswordReset(String userName) throws InvalidEmailAddressException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the user to request a password reset
InvalidEmailAddressException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response requestUsernames(String email) throws InvalidEmailAddressException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
email
- email address of the user
InvalidEmailAddressException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response getDirectGroups(String userName, String groupName, int maxResults, int startIndex) throws MembershipNotFoundException
userName
- name of the usergroupName
- name of the group (optional). If null, then all the groups that the user is a direct member of, are returned.maxResults
- maximum number of results to returnstartIndex
- start index of the result
MembershipNotFoundException
public javax.ws.rs.core.Response addUserToGroup(String userName, GroupEntity parentGroup) throws UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the userparentGroup
- parent group entity
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response removeUserFromGroup(String userName, String groupName) throws GroupNotFoundException, MembershipNotFoundException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the usergroupName
- name of the group
GroupNotFoundException
MembershipNotFoundException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
public javax.ws.rs.core.Response getNestedGroups(String userName, String groupName, int maxResults, int startIndex) throws MembershipNotFoundException
userName
- name of the usergroupName
- name of the group (optional). If null, then all the groups that the user is a nested member of, are returned.maxResults
- maximum number of results to returnstartIndex
- start index of the result
MembershipNotFoundException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |