src/uk/ac/ntu/n0521366/wsyd/libs/message/MessageLogin.java

   1 /*
   2  * The MIT License
   3  *
   4  * Copyright 2015 eddie.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 package uk.ac.ntu.n0521366.wsyd.libs.message;
  25
  26 import java.io.Serializable;
  27
  28 /**
  29  * Message used to authenticate a login with the SocialServer.
  30  *
  31  * @author eddie
  32  */
  33 public class MessageLogin extends MessageAbstract implements Serializable {
  34
  35     /**
  36      * Message type.
  37      */
  38     private static final String _type = "Login";
  39
  40     /**
  41      * A Username.
  42      */
  43     public final String _uName;
  44
  45     /**
  46      * A password.
  47      */
  48     public final String _uPass;
  49
  50     /**
  51      * After login the user's ID.
  52      */
  53     public long _userID = 0;
  54
  55     /**
  56      * Result of a login request.
  57      */
  58     public boolean _loggedIn = false;
  59
  60     /**
  61      * Make the Message printable.
  62      *
  63      * @return human readable text
  64      */
  65     public String toString() {
  66         return new String("_uName:" + _uName +
  67                           ",_uPass:" + _uPass +
  68                           ",_userID:" + _userID +
  69                           ",_loggedIn:" + _loggedIn
  70         );
  71     }
  72
  73     /**
  74      *  The Message Class type.
  75      *
  76      * @return Message type
  77      */
  78     public static String getType() {
  79         return _type;
  80     }
  81
  82     @Override
  83     public String getMessageType() {
  84         return _type;
  85     }
  86
  87     public MessageLogin() {
  88         this._uName = null;
  89         this._uPass = null;
  90     }
  91
  92     /**
  93      * Construct with a Username Password pair.
  94      *
  95      * @param uName Username
  96      * @param uPass Password
  97      */
  98     public MessageLogin (String uName, String uPass) {
  99         this._uName = uName;
 100         this._uPass = uPass;
 101     }
 102 }