net.bryansaunders.jee6divelog.service.rest
Class UserAccountApi

java.lang.Object
  net.bryansaunders.jee6divelog.service.rest.UserAccountApi

@RequestScoped
public class UserAccountApi
extends java.lang.Object

User Rest API.

Author:

Bryan Saunders

Constructor Summary

UserAccountApi()

Method Summary

javax.ws.rs.core.Response	deleteUser(java.lang.String userName) Deletes the User Specified by the Given Username.
javax.ws.rs.core.Response	findUser(UserAccount example) Gets the User Specified by the Given Criteria.
javax.ws.rs.core.Response	getAllUsers() Gets all Users.
javax.ws.rs.core.Response	getUser(java.lang.String userName) Gets the User Specified by the Given Username.
javax.ws.rs.core.Response	registerUser(UserAccount user) Registers a User.
javax.ws.rs.core.Response	updateUser(java.lang.String userName, UserAccount updatedUserAccount) Updates the User Specified by the Given Username.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserAccountApi

public UserAccountApi()

Method Detail

registerUser

public javax.ws.rs.core.Response registerUser(UserAccount user)

Registers a User.

• Status 200: Successful Registration.
• Status 400: Error with the Request. Most likely caused by an invalid UserAccount.

Parameters:

user - User to Register

Returns:

Registered User

findUser

public javax.ws.rs.core.Response findUser(UserAccount example)

Gets the User Specified by the Given Criteria. If not Criteria Specified, All Results will be returned.

• Status 200: Results Found.
• Status 400: Results not found.

Parameters:

example - Criteria to search for

Returns:

Found users

getAllUsers

public javax.ws.rs.core.Response getAllUsers()

Gets all Users.

• Status 200: Users Found.
• Status 400: No Users Found.

Returns:

List of Users

getUser

public javax.ws.rs.core.Response getUser(java.lang.String userName)

Gets the User Specified by the Given Username.

• Status 200: User Found.
• Status 400: User was not found.

Parameters:

userName - Username to serach for

Returns:

Found user

updateUser

public javax.ws.rs.core.Response updateUser(java.lang.String userName,
                                            UserAccount updatedUserAccount)

Updates the User Specified by the Given Username.

• Status 200: User Updated.

Parameters:

userName - Username to update

updatedUserAccount - Updated User Account

Returns:

Updated user

deleteUser

public javax.ws.rs.core.Response deleteUser(java.lang.String userName)

Deletes the User Specified by the Given Username.

• Status 200: User Delete.

Parameters:

userName - Username to delete

Returns:

Delete status