sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/protocol/ResolverResponseMsg.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.document.Document;
  60 import net.jxta.document.MimeMediaType;
  61 import net.jxta.document.StructuredDocument;
  62
  63
  64 /**
  65  * Generic Resolver Service message "Response".
  66  *
  67  * @see net.jxta.resolver.ResolverService
  68  *@see    net.jxta.protocol.ResolverQueryMsg
  69  * @see <a href="https://jxta-spec.dev.java.net/nonav/JXTAProtocols.html#proto-prp" target="_blank">JXTA Protocols Specification : Peer Resolver Protocol</a>
  70  **/
  71 public abstract class ResolverResponseMsg {
  72     private StructuredDocument credential = null;
  73
  74     private String handlername = null;
  75
  76     /**
  77      *  Description of the Field
  78      */
  79     public int queryid = 0;
  80
  81     private String response = null;
  82
  83     /**
  84      *  returns the credential
  85      *
  86      *@return    StructuredDocument credential
  87      */
  88     public StructuredDocument getCredential() {
  89         return credential;
  90     }
  91
  92     /**
  93      *  Write advertisement into a document. asMimeType is a mime media-type
  94      *  specification and provides the form of the document which is being
  95      *  requested. Two standard document forms are defined. "text/text" encodes
  96      *  the document in a form nice for printing out and "text/xml" which
  97      *  provides an XML format.
  98      *
  99      *@param  asMimeType  mime-type representation requested for that document
 100      *@return             Document document representing the advertisement
 101      */
 102     public abstract Document getDocument(MimeMediaType asMimeType);
 103
 104     /**
 105      * Set optional route information as part of the response.  This
 106      * information is just attached to the response and is ONLY used by the
 107      * resolver service. This information will not be sent as part of the
 108      * response msg and is not part of the resolver response wire format
 109      * protocol.
 110      *
 111      * @param route RouteAdvertisement to send the response
 112      */
 113     public abstract void setSrcPeerRoute(RouteAdvertisement route);
 114
 115     /**
 116      * Get optional route information that may be attached to the
 117      * response. This information is just attached to the response and
 118      * is only used internally by the resolver service. This information will
 119      * not be sent as part of the response msg and is not part of the
 120      * resolver response wire format.
 121      *
 122      * @return RouteAdvertisement to send the response
 123      */
 124     public abstract RouteAdvertisement  getSrcPeerRoute();
 125
 126     /**
 127      *  returns the handlername
 128      *
 129      *@return    String handlername name
 130      */
 131     public String getHandlerName() {
 132         return handlername;
 133     }
 134
 135     /**
 136      *  returns queryid value
 137      *
 138      *@return    int queryid value
 139      */
 140     public int getQueryId() {
 141         return queryid;
 142     }
 143
 144     /**
 145      *  returns the response body for this message.
 146      *
 147      *@return    the response body represented as a string.
 148      */
 149     public String getResponse() {
 150         return response;
 151     }
 152
 153     /**
 154      *  set the credential for this response.
 155      *
 156      *@param  cred  string credential
 157      */
 158
 159     public void setCredential(StructuredDocument cred) {
 160         this.credential = cred;
 161     }
 162
 163     /**
 164      *  set the handlername
 165      *
 166      *@param  name  string handlername
 167      */
 168     public void setHandlerName(String name) {
 169         this.handlername = name;
 170     }
 171
 172     /**
 173      *  set the query id to which this message is a response.
 174      *
 175      *@param  id  the query id for this response.
 176      */
 177     public void setQueryId(int id) {
 178         this.queryid = id;
 179     }
 180
 181     /**
 182      *  Set the response body for this message.
 183      *
 184      *@param  response  response body as a string.
 185      */
 186     public void setResponse(String response) {
 187         this.response = response;
 188     }
 189
 190     /**
 191      *  All messages have a type (in xml this is !doctype) which identifies the
 192      *  message
 193      *
 194      *@return    String type of the advertisement
 195      */
 196     public static String getAdvertisementType() {
 197         return "jxta:ResolverResponse";
 198     }
 199 }