org.appfuse.service
Interface UserService

All Known Implementing Classes:

UserManagerImpl

@Path(value="/users")
public interface UserService

Web Service interface so hierarchy of Generic Manager isn't carried through.

Method Summary

org.appfuse.model.User	getUser(String userId) Retrieves a user by userId.
org.appfuse.model.User	getUserByUsername(String username) Finds a user by their username.
List<org.appfuse.model.User>	getUsers() Retrieves a list of all users.
void	removeUser(String userId) Removes a user from the database by their userId
org.appfuse.model.User	saveUser(org.appfuse.model.User user) Saves a user's information

Method Detail

getUser

@Path(value="{id}")
org.appfuse.model.User getUser(String userId)

Retrieves a user by userId. An exception is thrown if user not found

Parameters:

userId - the identifier for the user

Returns:

User

getUserByUsername

org.appfuse.model.User getUserByUsername(String username)

Finds a user by their username.

Parameters:

username - the user's username used to login

Returns:

User a populated user object

getUsers

List<org.appfuse.model.User> getUsers()

Retrieves a list of all users.

Returns:

List

saveUser

org.appfuse.model.User saveUser(org.appfuse.model.User user)
                                throws UserExistsException

Saves a user's information

Parameters:

user - the user's information

Returns:

updated user

Throws:

UserExistsException - thrown when user already exists

removeUser

void removeUser(String userId)

Removes a user from the database by their userId

Parameters:

userId - the user's id