com.jivesoftware.community.webservices
Interface UserService

public interface UserService

Provides a webservice for managing user's, avatar's, and status levels.

Method Summary

User	createUser(java.lang.String username, java.lang.String password, java.lang.String email) Create a new user.
User	createUserWithUser(User user) Create a new user.
void	deleteUser(long userID) Delete the user with the specified id.
void	deleteUserProperty(java.lang.String name, long userID) Delete an extended property from a user.
User	getUser(long id) Returns a user by its id.
User	getUserByEmailAddress(java.lang.String emailAddress) Returns a user object corresponding to the email address given.
User	getUserByUsername(java.lang.String username) Returns a user by its username.
int	getUserCount() Returns the number of users in the system.
Property[]	getUserProperties(long userID) Return all extended properties for the user with the specified id.
User[]	getUsers() Returns the IDs of the first 1000 users.
User[]	getUsersBounded(int startIndex, int numResults) Returns the IDs of users begining at startIndex and until the number results equals numResults.
void	setPassword(long userID, java.lang.String password) Used to change a user's password.
void	setUserProperty(java.lang.String name, java.lang.String value, long userID) Set an extended property for a user.
void	updateUser(User user) Used to update user information in the system.

Method Detail

getUser

User getUser(long id)
             throws UserNotFoundException

Returns a user by its id.

Parameters:

id - The id of the user.

Returns:

The user with the matching id.

Throws:

UserNotFoundException - If the specified user does not exist.

getUserByUsername

User getUserByUsername(java.lang.String username)
                       throws UserNotFoundException

Returns a user by its username.

Parameters:

username - The username of the user.

Returns:

The user maching the username.

Throws:

UserNotFoundException - If the specified user does not exist.

updateUser

void updateUser(User user)
                throws UserNotFoundException,
                       UnauthorizedException,
                       com.jivesoftware.base.UserAlreadyExistsException

Used to update user information in the system.

Parameters:

user - User information to update.

Throws:

UserNotFoundException - If the specified user does not exist.

com.jivesoftware.base.UserAlreadyExistsException

UnauthorizedException

createUser

User createUser(java.lang.String username,
                java.lang.String password,
                java.lang.String email)
                throws com.jivesoftware.base.UserAlreadyExistsException

Create a new user.

Parameters:

username - The name of user.

password - The password for the user.

email - The email address of the user.

Returns:

The newly created user.

Throws:

com.jivesoftware.base.UserAlreadyExistsException - If the use with this name already exists.

createUserWithUser

User createUserWithUser(User user)
                        throws com.jivesoftware.base.UserAlreadyExistsException

Create a new user. The id field is ignored, after creation the user object returned will have the correct user id.

Parameters:

user - The user to create.

Returns:

The newly created user. The id will be the correct user id.

Throws:

com.jivesoftware.base.UserAlreadyExistsException - If the use with this name already exists.

deleteUser

void deleteUser(long userID)
                throws UserNotFoundException

Delete the user with the specified id.

Parameters:

userID - The id of the user to delete.

Throws:

UserNotFoundException - If the specified user does not exist.

getUserProperties

Property[] getUserProperties(long userID)
                             throws UserNotFoundException

Return all extended properties for the user with the specified id.

Parameters:

userID - The user's id.

Returns:

All the user's extended properties.

Throws:

UserNotFoundException - If the specified user does not exist.

setUserProperty

void setUserProperty(java.lang.String name,
                     java.lang.String value,
                     long userID)
                     throws UserNotFoundException

Set an extended property for a user.

Parameters:

name - The name of the extended property.

value - The value of the extended property.

userID - The user to set an extended property for.

Throws:

UserNotFoundException - If the specified user does not exist.

deleteUserProperty

void deleteUserProperty(java.lang.String name,
                        long userID)
                        throws UserNotFoundException

Delete an extended property from a user.

Parameters:

name - Name of the extended property to delete.

userID - The id of the user to delete the extended property from.

Throws:

UserNotFoundException - If the specified user does not exist.

getUserCount

int getUserCount()

Returns the number of users in the system.

Returns:

The number of users in the system.

getUsersBounded

User[] getUsersBounded(int startIndex,
                       int numResults)

Returns the IDs of users begining at startIndex and until the number results equals numResults.

Parameters:

startIndex - The startIndex to grab results from.

numResults - The total number of results to be returned.

Returns:

An array of User IDs.

getUsers

User[] getUsers()

Returns the IDs of the first 1000 users.

Returns:

An array of user IDs.

getUserByEmailAddress

User getUserByEmailAddress(java.lang.String emailAddress)
                           throws UserNotFoundException

Returns a user object corresponding to the email address given.

Parameters:

emailAddress - The email address of the user.

Returns:

The User with the matching email address.

Throws:

UserNotFoundException - If the specified user does not exist.

setPassword

void setPassword(long userID,
                 java.lang.String password)
                 throws UserNotFoundException

Used to change a user's password.

Parameters:

userID - The id of the user to change the password for.

password - The new password in plain text.

Throws:

UserNotFoundException