sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/protocol/PeerInfoResponseMessage.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.protocol;
  58
  59
  60 import net.jxta.document.Document;
  61 import net.jxta.document.Element;
  62 import net.jxta.document.MimeMediaType;
  63 import net.jxta.document.StructuredDocument;
  64 import net.jxta.document.StructuredDocumentUtils;
  65 import net.jxta.peer.PeerID;
  66
  67
  68 /**
  69  * This abstract class define the PeerInfoService advertisement.
  70  */
  71
  72 public abstract class PeerInfoResponseMessage {
  73
  74     /**
  75      * The Sender's (or Querying) Peer Id.
  76      */
  77     private PeerID spid = null;
  78
  79     /**
  80      * Peer Id of the peer which published this advertisement.
  81      */
  82     private PeerID tpid = null;
  83
  84     /** String representing response  */
  85     private StructuredDocument response = null;
  86
  87     /**
  88      * Time in seconds since this peer was started.
  89      */
  90     private long uptime = 0;
  91
  92     /**
  93      * Time in milliseconds when this peer was last polled since
  94      * "the epoch", namely January 1, 1970, 00:00:00 GMT.
  95      */
  96     private long timestamp = 0;
  97
  98     public PeerInfoResponseMessage() {
  99         super();
 100     }
 101
 102     /**
 103      * returns the Message type
 104      * @return a string
 105      *
 106      */
 107     public static String getMessageType() {
 108         return "jxta:PeerInfoResponseMessage";
 109     }
 110
 111     /**
 112      * returns the sender's pid
 113      *
 114      * @return a string representing the peer's id
 115      *
 116      */
 117     public PeerID getSourcePid() {
 118         return spid;
 119     }
 120
 121     /**
 122      * sets the sender's pid
 123      *
 124      * @param pid a string representing a peer's id
 125      *
 126      */
 127     public void setSourcePid(PeerID pid) {
 128         this.spid = pid;
 129     }
 130
 131     /**
 132      * returns the target pid
 133      *
 134      * @return a string representing the peer's id
 135      *
 136      */
 137     public PeerID getTargetPid() {
 138         return tpid;
 139     }
 140
 141     /**
 142      * sets the target's pid
 143      *
 144      * @param pid a string representing a peer's id
 145      *
 146      */
 147     public void setTargetPid(PeerID pid) {
 148         this.tpid = pid;
 149     }
 150
 151     /**
 152      * returns the response
 153      *
 154      * @return a structured document representing request
 155      *
 156      */
 157     public Element getResponse() {
 158         if (null != response) {
 159             return StructuredDocumentUtils.copyAsDocument(response);
 160         } else {
 161             return null;
 162         }
 163     }
 164
 165     /**
 166      * sets the request
 167      *
 168      * @param response a structured document representing a peerinfo request
 169      *
 170      */
 171     public void setResponse(Element response) {
 172         if (null != response) {
 173             this.response = StructuredDocumentUtils.copyAsDocument(response);
 174         } else {
 175             this.response = null;
 176         }
 177     }
 178
 179     /**
 180      * returns the number of milliseconds since this peer was started
 181      * @return the number of milliseconds
 182      *
 183      */
 184     public long getUptime() {
 185         return uptime;
 186     }
 187
 188     /**
 189      * sets the number of milliseconds since this peer was started
 190      * @param milliseconds the number of milliseconds since this peer was started
 191      *
 192      */
 193     public void setUptime(long milliseconds) {
 194         this.uptime = milliseconds;
 195     }
 196
 197     /**
 198      * returns the time when this peer was last polled
 199      *
 200      * @return long time in milliseconds when this peer was last polled in
 201      * milliseconds since "the epoch", namely January 1, 1970, 00:00:00
 202      * GMT.
 203      *
 204      */
 205     public long getTimestamp() {
 206         return timestamp;
 207     }
 208
 209     /**
 210      * sets the time when this peer was last polled
 211      *
 212      * @param milliseconds time in milliseconds when this peer was last polled
 213      * in milliseconds since "the epoch", namely January 1, 1970, 00:00:00
 214      * GMT.
 215      *
 216      */
 217     public void setTimestamp(long milliseconds) {
 218         this.timestamp = milliseconds;
 219     }
 220
 221     public abstract Document getDocument(MimeMediaType encodeAs);
 222
 223 }
 224