sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/protocol/RouteResponseMsg.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.MimeMediaType;
  62
  63
  64 /**
  65  * Sent by peers in response to Route Query Messages as part of the Endpoint
  66  * Router Protocol (ERp). Contains a route advertisement for the destination
  67  * peer. Route Response Messages are transmitted as responses within Resolver
  68  * Response Message.
  69  *
  70  * @deprecated This message is private to the Endpoint Router implementation and
  71  * not part of the JXTA public API. It will be moved from this package.
  72  *
  73  * @see net.jxta.protocol.RouteQueryMsg
  74  * @see    <a href="https://jxta-spec.dev.java.net/nonav/JXTAProtocols.html#proto-erp"
  75  *         target="_blank">JXTA Protocols Specification : Endpoint Routing Protocol</a>
  76  **/
  77 @Deprecated
  78 public abstract class RouteResponseMsg {
  79
  80     private RouteAdvertisement dstRoute = null;
  81     private RouteAdvertisement srcRoute = null;
  82
  83     /**
  84      * All messages have a type (in xml this is !doctype)
  85      * which identifies the message
  86      * @return String "jxta:ERR"
  87      */
  88
  89     public static String getAdvertisementType() {
  90         return "jxta:ERR";
  91     }
  92
  93     /**
  94      * set the destination route we were looking for
  95      *
  96      * @param dst destination route
  97      */
  98
  99     public void setDestRoute(RouteAdvertisement dst) {
 100         dstRoute = dst;
 101     }
 102
 103     /**
 104      * returns the destination route we were looking for
 105      *
 106      * @return route destination route advertisement
 107      */
 108
 109     public RouteAdvertisement getDestRoute() {
 110         return  dstRoute;
 111     }
 112
 113     /**
 114      * Set the Route advertisement of the source peer that is originating
 115      * the query
 116      *
 117      * @param route RouteAdvertisement of the source
 118      */
 119
 120     public void setSrcRoute(RouteAdvertisement route) {
 121         srcRoute = route;
 122     }
 123
 124     /**
 125      * Returns the route of the src peer that responded
 126      *
 127      * @return route RouteAdvertisement of the source peer
 128      * that responded to the query
 129      */
 130
 131     public RouteAdvertisement getSrcRoute() {
 132         return  srcRoute;
 133     }
 134
 135     /**
 136      * Write advertisement into a document. asMimeType is a mime media-type
 137      * specification and provides the form of the document which is being
 138      * requested. Two standard document forms are defined. "text/text" encodes
 139      * the document in a form nice for printing out, and "text/xml" which
 140      * provides an XML representation.
 141      *
 142      * @param asMimeType mime-type format requested
 143      * @return Document representation of the document as an advertisement
 144      */
 145
 146     public abstract Document getDocument(MimeMediaType asMimeType);
 147 }