src/uk/ac/ntu/n0521366/wsyd/libs/message/MessagePresence.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 uk.ac.ntu.n0521366.wsyd.libs.net.WSYD_SocketAddress;
  27
  28 /**
  29  *
  30  * @author TJ <hacker@iam.tj>
  31  */
  32 public class MessagePresence extends MessageAbstract {
  33     private static final String _type = "Presence";
  34
  35     /**
  36      * Return the class type without needing an instance object.
  37      *
  38      * Workaround for Java not permitting 'abstract static' qualifiers which would
  39      * allow static methods in abstract base classes to be overridden in sub-classes.
  40      *
  41      * @return class type
  42      */
  43     public static String getType() {
  44         return _type;
  45     }
  46
  47     /**
  48      * The title of the service advertising itself.
  49      *
  50      * E.g. "ServerSocial", "ServerChat", "ServerLog","UserSocial", 'UserChat",  "Notify"
  51      */
  52     public String serviceName;
  53
  54     /**
  55      * The port number this service listens on.
  56      *
  57      * The IP address should be set by the receiving service in the sourceAddress property.
  58      */
  59     public WSYD_SocketAddress socketAddress;
  60
  61     /**
  62      * The message type
  63      * @return "Presence"
  64      */
  65     @Override
  66     public String getMessageType() {
  67         return _type;
  68     }
  69
  70     public MessagePresence(String service, WSYD_SocketAddress socketAddress) {
  71         super();
  72         this.serviceName = service;
  73         this.socketAddress = socketAddress;
  74     }
  75 }