sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/protocol/DiscoveryQueryMsg.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 package net.jxta.protocol;
  57
  58
  59 import net.jxta.discovery.DiscoveryService;
  60 import net.jxta.document.Document;
  61 import net.jxta.document.MimeMediaType;
  62
  63
  64 /**
  65  * This class defines the Discovery Service message "Query". The default
  66  * behavior of this abstract class is simply a place holder for the generic
  67  * resolver query fields.
  68  *
  69  * @see net.jxta.discovery.DiscoveryService
  70  * @see net.jxta.protocol.DiscoveryResponseMsg
  71  */
  72
  73 public abstract class DiscoveryQueryMsg {
  74
  75     private PeerAdvertisement peerAdvertisement = null;
  76
  77     /**
  78      * default threshold to limit the number of responses from one peer
  79      */
  80     private int threshold = 10;
  81
  82     /**
  83      * FIXME 20030227 bondolo@jxta.org not a great default...
  84      */
  85     private int type = DiscoveryService.PEER;
  86
  87     private String attr = null;
  88     private String value = null;
  89
  90     /**
  91      * returns the Attr value
  92      *
  93      * @return String value of Attribute
  94      */
  95     public String getAttr() {
  96         return attr;
  97     }
  98
  99     /**
 100      * Get the response type
 101      *
 102      * @return int PEER, or GROUP discovery type response
 103      */
 104     public int getDiscoveryType() {
 105         return type;
 106     }
 107
 108     /**
 109      * Write advertisement into a document. asMimeType is a mime media-type
 110      * specification and provides the form of the document which is being
 111      * requested. Two standard document forms are defined. "text/text" encodes
 112      * the document in a form nice for printing out, and "text/xml" which
 113      * provides an XML representation.
 114      *
 115      * @param asMimeType mime-type format requested
 116      * @return Document representation of the document as an
 117      *         advertisement
 118      */
 119     public abstract Document getDocument(MimeMediaType asMimeType);
 120
 121     /**
 122      * returns the responding peer advertisement
 123      *
 124      * @return String handlername name
 125      * @deprecated Peer Advertisement is available directly via
 126      *             {@link #getPeerAdvertisement()}.
 127      */
 128     @Deprecated
 129     public String getPeerAdv() {
 130         if (null != peerAdvertisement) {
 131             return peerAdvertisement.toString();
 132         } else {
 133             return null;
 134         }
 135     }
 136
 137     /**
 138      * returns the querying peer's advertisement
 139      *
 140      * @return peer advertisement of querier.
 141      */
 142     public PeerAdvertisement getPeerAdvertisement() {
 143         return peerAdvertisement;
 144     }
 145
 146     /**
 147      * returns the responding peer's advertisement
 148      *
 149      * @param newAdv peer advertisement of querier.
 150      */
 151     public void setPeerAdvertisement(PeerAdvertisement newAdv) {
 152         peerAdvertisement = newAdv;
 153     }
 154
 155     /**
 156      * Get the Threshold for number of responses
 157      *
 158      * @return int threshold
 159      */
 160     public int getThreshold() {
 161         return threshold;
 162     }
 163
 164     /**
 165      * returns the value of Attr
 166      *
 167      * @return String
 168      */
 169     public String getValue() {
 170         return value;
 171     }
 172
 173     /**
 174      * set the attr
 175      *
 176      * @param attr attribute of the query
 177      */
 178     public void setAttr(String attr) {
 179         this.attr = attr;
 180     }
 181
 182     /**
 183      * set the Response type whether it's peer, or group discovery
 184      *
 185      * @param type type of discovery
 186      */
 187     public void setDiscoveryType(int type) {
 188         // FIXME 20030227 bondolo@jxta.org This should be value checked.
 189         this.type = type;
 190     }
 191
 192     /**
 193      * set the threshold
 194      *
 195      * @param threshold value to be set
 196      */
 197     public void setThreshold(int threshold) {
 198         this.threshold = threshold;
 199     }
 200
 201     /**
 202      * set the query
 203      *
 204      * @param value value of the attribute to query
 205      */
 206     public void setValue(String value) {
 207         this.value = value;
 208     }
 209
 210     /**
 211      * All messages have a type (in xml this is &#0033;doctype) which
 212      * identifies the message
 213      *
 214      * @return String "jxta:DiscoveryQuery"
 215      */
 216     public static String getAdvertisementType() {
 217         return "jxta:DiscoveryQuery";
 218     }
 219 }
 220