sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/protocol/ResolverSrdiMsg.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.credential.Credential;
  62
  63
  64 /**
  65  * ResolverSrdiMsg is generic resolver wrapper for Services that wish to
  66  * implement their own distribution of indices. this message provides the
  67  * scoping within the group, and service. In addition it also defines a credential
  68  * which should be verified by the service.
  69  */
  70
  71 public abstract class ResolverSrdiMsg {
  72
  73     private String handlername = null;
  74     private Credential credential = null;
  75     private String payload = null;
  76
  77     /**
  78      * All messages have a type (in xml this is !doctype)
  79      * which identifies the message
  80      *
  81      * @return    String type of the advertisement
  82      */
  83
  84     public static String getMessageType() {
  85         return "jxta:ResolverSRDI";
  86     }
  87
  88     /**
  89      * returns the handlername
  90      *
  91      * @return    String handlername name
  92      *
  93      */
  94
  95     public String getHandlerName() {
  96         return handlername;
  97     }
  98
  99     /**
 100      * returns the credential
 101      *
 102      * @return    StructuredDocument credential
 103      */
 104
 105     public Credential getCredential() {
 106         return credential;
 107     }
 108
 109     /**
 110      * returns the payload
 111      *
 112      * @return    String value of query
 113      */
 114
 115     public String getPayload() {
 116         return payload;
 117     }
 118
 119     /**
 120      * set the handlername
 121      *
 122      * @param  name  string handlername
 123      */
 124
 125     public void setHandlerName(String name) {
 126         this.handlername = name;
 127     }
 128
 129     /**
 130      * set the credential object
 131      *
 132      * @param  cred  credential
 133      */
 134
 135     public void setCredential(Credential cred) {
 136         this.credential = cred;
 137     }
 138
 139     /**
 140      * set the SRDI payload
 141      *
 142      * @param  payload   The new payload value
 143      */
 144
 145     public void setPayload(String payload) {
 146         this.payload = payload;
 147     }
 148
 149     /**
 150      * Write advertisement into a document. asMimeType is a mime media-type
 151      * specification and provides the form of the document which is being
 152      * requested. Two standard document forms are defined. "text/text" encodes
 153      * the document in a form nice for printing out and "text/xml" which
 154      * provides an XML format.
 155      *
 156      * @param  asMimeType  mime-type representation requested for that document
 157      * @return             Document document representing the advertisement
 158      */
 159
 160     public abstract Document getDocument(MimeMediaType asMimeType);
 161
 162 }
 163