Merge pull request #8 from RIT-SWEN-261-02/api-auth

First attempt at an authentication system.

1 files changed, 10 insertions, 11 deletions

diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserDAO.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserDAO.java
index d456abc..29d46cf 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserDAO.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserDAO.java
@@ -21,17 +21,17 @@ public interface UserDAO {
     User[] getUsers() throws IOException;
 
     /**
-     * Retrieves a {@linkplain User user} with the given name
+     * Retrieves a {@linkplain User user} with the given username
      * 
-     * @param id The ID of the {@link User user} to get
+     * @param username The ID of the {@link User user} to get
      * 
-     * @return a {@link User user} object with the matching name
+     * @return a {@link User user} object with the matching username
      *         <br>
-     *         null if no {@link User user} with a matching name is found
+     *         null if no {@link User user} with a matching username is found
      * 
      * @throws IOException if an issue with underlying storage
      */
-    User getUser(String name) throws IOException;
+    User getUser(String username) throws IOException;
 
     /**
      * Creates and saves a {@linkplain User user}
@@ -44,25 +44,24 @@ public interface UserDAO {
      * 
      * @throws IOException if an issue with underlying storage
      */
-    User createUser(User user) throws IOException;
+    User addUser(User user) throws IOException;
 
     /**
      * Updates and saves a {@linkplain User user}
      * 
-     * @param newUser {@link User user} object to be updated and saved
-     * @param name {@link String name} name of object to be updated
+     * @param user {@link User user} object to be updated and saved
      * 
      * @return updated {@link User user} if successful, null if
      *         {@link User user} could not be found
      * 
      * @throws IOException if underlying storage cannot be accessed
      */
-    User updateUser(User newUser, String name) throws IOException;
+    User updateUser(User user) throws IOException;
 
     /**
      * Deletes a {@linkplain User user} with the given id
      * 
-     * @param id The id of the {@link User user}
+     * @param username The id of the {@link User user}
      * 
      * @return true if the {@link User user} was deleted
      *         <br>
@@ -70,5 +69,5 @@ public interface UserDAO {
      * 
      * @throws IOException if underlying storage cannot be accessed
      */
-    boolean deleteUser(String name) throws IOException;
+    boolean deleteUser(String username) throws IOException;
 }