sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/impl/src/net/jxta/impl/protocol/RouteQuery.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.impl.protocol;
  58
  59
  60 import net.jxta.document.AdvertisementFactory;
  61 import net.jxta.document.Attributable;
  62 import net.jxta.document.Attribute;
  63 import net.jxta.document.Document;
  64 import net.jxta.document.Element;
  65 import net.jxta.document.MimeMediaType;
  66 import net.jxta.document.StructuredDocument;
  67 import net.jxta.document.StructuredDocumentFactory;
  68 import net.jxta.document.StructuredDocumentUtils;
  69 import net.jxta.document.XMLElement;
  70 import net.jxta.id.IDFactory;
  71 import net.jxta.peer.PeerID;
  72 import net.jxta.protocol.RouteAdvertisement;
  73 import net.jxta.protocol.RouteQueryMsg;
  74
  75 import java.lang.reflect.UndeclaredThrowableException;
  76 import java.net.URI;
  77 import java.net.URISyntaxException;
  78 import java.util.Collection;
  79 import java.util.Enumeration;
  80 import net.jxta.document.XMLDocument;
  81
  82 /**
  83  * RouteQuery message used by the Endpoint Routing protocol to
  84  * query for route
  85  */
  86 public class RouteQuery extends RouteQueryMsg {
  87
  88     private static final String destPIDTag = "Dst";
  89     private static final String srcRouteTag = "Src";
  90     private static final String badHopTag = "Bad";
  91
  92     /**
  93      * Default Constructor
  94      */
  95     public RouteQuery() {}
  96
  97     /**
  98      * Constructs a RouteQuery
  99      *
 100      * @deprecated Use default constructor and accessors.
 101      *
 102      * @param dest     dest PeerID
 103      * @param srcRoute source source
 104      * @param badhops  lis of AccessPointAdvertisements
 105      */
 106     @Deprecated
 107     public RouteQuery(PeerID dest, RouteAdvertisement srcRoute, Collection<PeerID> badhops) {
 108         setDestPeerID(dest);
 109         setSrcRoute(srcRoute);
 110         setBadHops(badhops);
 111     }
 112
 113     /**
 114      * Construct from an XML document fragment.
 115      *
 116      * @param doc the element
 117      */
 118     public RouteQuery(XMLElement doc) {
 119         String doctype = doc.getName();
 120
 121         if (!doctype.equals(getAdvertisementType())) {
 122             throw new IllegalArgumentException(
 123                     "Can not construct : " + getClass().getName() + " from doc containing a " + doctype);
 124         }
 125
 126         Enumeration<XMLElement> elements = doc.getChildren();
 127
 128         while (elements.hasMoreElements()) {
 129             XMLElement elem = elements.nextElement();
 130
 131             if (elem.getName().equals(destPIDTag)) {
 132                 try {
 133                     URI pID = new URI(elem.getTextValue());
 134                     PeerID pid = (PeerID) IDFactory.fromURI(pID);
 135
 136                     setDestPeerID(pid);
 137                 } catch (URISyntaxException badID) {
 138                     throw new IllegalArgumentException("Bad PeerID ID in advertisement");
 139                 } catch (ClassCastException badID) {
 140                     throw new IllegalArgumentException("Not a peer id");
 141                 }
 142                 continue;
 143             }
 144
 145             if (elem.getName().equals(srcRouteTag)) {
 146                 for (Enumeration<XMLElement> eachXpt = elem.getChildren(); eachXpt.hasMoreElements();) {
 147                     XMLElement aXpt = eachXpt.nextElement();
 148
 149                     RouteAdvertisement route = (RouteAdvertisement) AdvertisementFactory.newAdvertisement(aXpt);
 150
 151                     setSrcRoute(route);
 152                 }
 153                 continue;
 154             }
 155
 156             if (elem.getName().equals(badHopTag)) {
 157                 try {
 158                     URI pID = new URI(elem.getTextValue());
 159                     PeerID pid = (PeerID) IDFactory.fromURI(pID);
 160
 161                     addBadHop(pid);
 162                 } catch (URISyntaxException badID) {
 163                     throw new IllegalArgumentException("Bad PeerID ID in advertisement");
 164                 } catch (ClassCastException badID) {
 165                     throw new IllegalArgumentException("Not a peer id");
 166                 }
 167             }
 168         }
 169
 170         if(null == getDestPeerID()) {
 171             throw new IllegalArgumentException("Destination peer not initialized");
 172         }
 173     }
 174
 175     /**
 176      * {@inheritDoc}
 177      */
 178     @Override
 179     public StructuredDocument getDocument(MimeMediaType asMimeType) {
 180         if(null == getDestPeerID()) {
 181             throw new IllegalStateException("Destination peer not initialized");
 182         }
 183
 184         StructuredDocument adv = StructuredDocumentFactory.newStructuredDocument(asMimeType, getAdvertisementType());
 185
 186         if (adv instanceof XMLElement) {
 187             ((Attributable) adv).addAttribute("xmlns:jxta", "http://jxta.org");
 188             ((Attributable) adv).addAttribute("xml:space", "preserve");
 189         }
 190
 191         Element e;
 192
 193         PeerID dest = getDestPeerID();
 194
 195         e = adv.createElement(destPIDTag, dest.toString());
 196         adv.appendChild(e);
 197
 198         RouteAdvertisement route = getSrcRoute();
 199
 200         if (route != null) {
 201             e = adv.createElement(srcRouteTag);
 202             adv.appendChild(e);
 203             StructuredDocument xptDoc = (StructuredDocument) route.getDocument(asMimeType);
 204
 205             StructuredDocumentUtils.copyElements(adv, e, xptDoc);
 206         }
 207
 208         for (PeerID eachPeer : getBadHops()) {
 209             e = adv.createElement(badHopTag, eachPeer.toString());
 210             adv.appendChild(e);
 211         }
 212
 213         return adv;
 214     }
 215
 216     /**
 217      * return a string representation of this RouteQuery doc
 218      */
 219     @Override
 220     public String toString() {
 221         XMLDocument doc = (XMLDocument) getDocument(MimeMediaType.XMLUTF8);
 222
 223         doc.addAttribute("xml:space", "default");
 224
 225         return doc.toString();
 226     }
 227 }