discoveryresponsemsg.java

jxme的一些相关程序,主要是手机上程序开发以及手机和计算机通信的一些程序资料,程序编译需要Ant支持

/*
 * Copyright (c) 2001 Sun Microsystems, Inc.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact Project JXTA at http://www.jxta.org.
 *
 * 5. Products derived from this software may not be called "JXTA",
 *    nor may "JXTA" appear in their name, without prior written
 *    permission of Sun.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Project JXTA.  For more
 * information on Project JXTA, please see
 * <http://www.jxta.org/>.
 *
 * This license is based on the BSD license adopted by the Apache Foundation.
 *
 * $Id: DiscoveryResponseMsg.java,v 1.2 2002/03/04 20:19:21 echtcherbina Exp $
 */

package net.jxta.protocol;

import java.util.Enumeration;
import java.util.Vector;

import net.jxta.document.Document;
import net.jxta.document.MimeMediaType;


/**
 * This class defines the DiscoveryService message "Response"
 * The default behavior of this abstract class is simply a
 * place holder for the generic resolver query fields. This message
 * is the response to the DiscoveryQueryMsg.
 *
 *
 * <p>This message is part of the Peer DiscoveryService protocol
 *
 * <pre>
 * &lt;?xml version="1.0"?&gt;
 * &lt;jxta:DiscoveryResponse&gt;
 *   &lt;Count&gt;int&lt;Count&gt;
 *   &lt;Type&gt;int&lt;/Type&gt;
 *   &lt;PeerAdv&gt; adv &lt;/PeerAdv&gt;
 *   &lt;Attr&gt; attribute &lt;/Attr&gt;
 *   &lt;Value&gt; value &lt;/Aalue&gt;
 *   &lt;Response Expiration="expiration" &gt;adv&lt;/Response&gt;
 *     ......
 *   &lt;Response Expiration="expiration" &gt;adv&lt;/Response&gt;
 * &lt;/jxta:DiscoveryResponse&gt;
 *</pre>
 *
 * @see net.jxta.protocol.DiscoveryQueryMsg
 * @since JXTA 1.0
 *
 */


public abstract class DiscoveryResponseMsg {

    public int type=0;
    private String peeradv=null;
    private Vector responses=null;
    private Vector expirations=null;
    public int count = 0;
    private String attr = null;
    private String value = null;


    /**
     * All messages have a type (in xml this is !doctype)
     * which identifies the message
     * @return String "jxta:ResolverResponse"
     *
     * @since JXTA 1.0
     */

    public static String getAdvertisementType() {
	return "jxta:DiscoveryResponse" ;
    }

    /**
     * Get the reponse count
     * @return int count
     *
     * @since JXTA 1.0
     */

    public int getResponseCount() {
	return count;
    }


    /**
     * Get the response type
     * @return int type of discovery message PEER, or GROUP discovery type response
     *
     * @since JXTA 1.0
     */

    public int getDiscoveryType() {
	return type;
    }

    /**
     * returns the responding's peer advertisement
     * @return String handlername peer advertisement
     *
     * @since JXTA 1.0
     */

    public String getPeerAdv() {
	return peeradv;
    }

    /**
     * returns the attributes used by the query
     * @return String attribute of the query
     *
     * @since JXTA 1.0
     */

    public String getQueryAttr() {
	 return attr;
    }

    /**
     * returns the value used by the query
     * @return String value used by the query
     *
     * @since JXTA 1.0
     */

    public String getQueryValue() {
	 return value;
    }


    /**
     * returns the response(s)
     * @return Enumeration of String responses
     *
     * @since JXTA 1.0
     */

    public Enumeration getResponses() {
	 return responses.elements();
    }

    public Enumeration getExpirations () {
     return expirations.elements();
    }


    /**
     * set the response count in this message
     * @param count number of response in this message
     *
     * @since JXTA 1.0
     */

    public void setResponseCount(int count) {
	this.count=count;
    }

    /**
     * set the Response type whether it's peer, or group dsicovery
     * @param type int representing the type
     *
     * @since JXTA 1.0
     */

    public void setDiscoveryType(int type) {
	this.type=type;
    }

    /**
     * set the response peer advertisement
     * @param peer
     *
     * @since JXTA 1.0
     */

    public void setPeerAdv(String peer) {
	this.peeradv=peer;
    }

    /**
     * set the attribute used by the query
     * @param attr
     *
     * @since JXTA 1.0
     */

    public void setQueryAttr(String attr) {
	this.attr=attr;
    }

    /**
     * set the value used by the query
     * @param value
     *
     * @since JXTA 1.0
     */

    public void setQueryValue(String value) {
	this.value=value;
    }

    /**
     * set the responses to the query
     * @param responses
     *
     * @since JXTA 1.0
     */

    public void setResponses(Vector responses) {
	this.responses=responses;
    }


    public void setExpirations (Vector expirations) {
	this.expirations = expirations;
    }

    /**
     * Write advertisement into a document. asMimeType is a mime media-type
     * specification and provides the form of the document which is being
     * requested. Two standard document forms are defined. "text/text" encodes
     * the document in a form nice for printing out and "text/xml" which
     * provides an XML format.
     *
     * @param asMimeType  mime-typ requested
     * @return Document document that represents the advertisement
     *
     * @exception Exception error generating the document representing the message.
     * @since JXTA 1.0
     */

    public abstract Document getDocument ( MimeMediaType asMimeType )
      throws Exception;
}