Add Registration functionality and tidy up
[WeStealzYourDataz.git] / src / uk / ac / ntu / n0521366 / wsyd / libs / message / MessageLogin.java
index 608bc89..6c58f52 100644 (file)
  */
 package uk.ac.ntu.n0521366.wsyd.libs.message;
 
+import java.io.Serializable;
+
 /**
  * Message used to authenticate a login with the SocialServer.
  *
  * @author eddie
  */
-public class MessageLogin extends MessageAbstract {
+public class MessageLogin extends MessageAbstract implements Serializable {
     
+    /**
+     * Message type.
+     */
     private static final String _type = "Login";
     
+    /**
+     * A Username.
+     */
     public final String _uName;
     
+    /**
+     * A password.
+     */
     public final String _uPass;
     
+    /**
+     * After login the user's ID.
+     */
     public long _userID = 0;
     
+    /**
+     * Result of a login request.
+     */
     public boolean _loggedIn = false;
     
+    /**
+     * Make the Message printable.
+     * 
+     * @return human readable text
+     */
+    public String toString() {
+        return new String("_uName:" + _uName + 
+                          ",_uPass:" + _uPass +
+                          ",_userID:" + _userID +
+                          ",_loggedIn:" + _loggedIn
+        );
+    }
+    
+    /** 
+     *  The Message Class type.
+     * 
+     * @return Message type
+     */
     public static String getType() {
         return _type;
     }
@@ -54,9 +89,14 @@ public class MessageLogin extends MessageAbstract {
         this._uPass = null;
     }
     
+    /**
+     * Construct with a Username Password pair.
+     * 
+     * @param uName Username
+     * @param uPass Password
+     */
     public MessageLogin (String uName, String uPass) {
         this._uName = uName;
         this._uPass = uPass;
-    }
-    
+    }  
 }