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

   1 /*
   2  * The MIT License
   3  *
   4  * Copyright 2015 TJ <hacker@iam.tj>.
   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 import java.net.InetAddress;
  28
  29 /**
  30  * Base class of all Message types.
  31  *
  32  * @author TJ <hacker@iam.tj>
  33  */
  34 public abstract class MessageAbstract implements Serializable {
  35     /**
  36      * The purpose of this class of message.
  37      *
  38      * @return E.g. "LogRecord", "FriendOnline", "ChatRequest"
  39      */
  40     public abstract String getMessageType();
  41
  42     /**
  43      * IP address of the sending host.
  44      *
  45      * This should be set by the <em>receiving service</em> using the value obtained from
  46      * the packet or connection the message arrived in.
  47      *
  48      * FIXME: sourceAddress: is this really needed? the message encapsulated in a NetworkMessage already
  49      */
  50     public InetAddress sourceAddress;
  51
  52     public MessageAbstract() {
  53         sourceAddress = null;
  54     }
  55 }