stdrendezvousservice.java

jxta_src_2.41b jxta 2.41b 最新版源码 from www.jxta.org

/*
 *
 * $Id: StdRendezVousService.java,v 1.11 2006/08/10 20:04:50 hamada Exp $
 *
 * 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.
 */

package net.jxta.impl.rendezvous;


import java.net.URI;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.Timer;
import java.util.Iterator;
import java.util.List;

import java.io.IOException;
import java.net.URISyntaxException;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

import net.jxta.discovery.DiscoveryService;
import net.jxta.document.AdvertisementFactory;
import net.jxta.document.XMLDocument;
import net.jxta.document.StructuredDocumentFactory;
import net.jxta.endpoint.EndpointAddress;
import net.jxta.endpoint.EndpointListener;
import net.jxta.endpoint.Message;
import net.jxta.endpoint.Messenger;
import net.jxta.endpoint.MessageElement;
import net.jxta.endpoint.TextDocumentMessageElement;
import net.jxta.id.ID;
import net.jxta.id.IDFactory;
import net.jxta.peer.PeerID;
import net.jxta.peergroup.PeerGroup;
import net.jxta.protocol.PeerAdvertisement;
import net.jxta.protocol.RouteAdvertisement;

import net.jxta.impl.rendezvous.rpv.PeerViewElement;
import net.jxta.impl.rendezvous.rendezvousMeter.RendezvousMeterBuildSettings;
import net.jxta.impl.util.TimeUtils;
import net.jxta.impl.util.TimerThreadNamer;


/**
 * Base class for providers which implement the JXTA Standard Rendezvous
 * Protocol.
 *
 * @see <a href="http://spec.jxta.org/nonav/v1.0/docbook/JXTAProtocols.html#proto-rvp" target="_blank">JXTA Protocols Specification : Rendezvous Protocol</a>
 **/
public abstract class StdRendezVousService extends RendezVousServiceProvider {
    
    /**
     *  Log4J Category
     **/
    private final static Logger LOG = Logger.getLogger(StdRendezVousService.class.getName());
    
    public final static String ConnectRequest = "Connect";
    public final static String DisconnectRequest = "Disconnect";
    public final static String ConnectedPeerReply = "ConnectedPeer";
    public final static String ConnectedLeaseReply = "ConnectedLease";
    public final static String ConnectedRdvAdvReply = "RdvAdvReply";
    public final static String RdvAdvReply = "RdvAdv";
    
    /**
     * Default Maximum TTL.
     **/
    protected static final int DEFAULT_MAX_TTL = 200;
    
    protected final String              pName;
    protected final String              pParam;
    
    /**
     *  The registered handler for messages using the Standard Rendezvous
     *  Protocol.
     *
     *  @see <a href="http://spec.jxta.org/nonav/v1.0/docbook/JXTAProtocols.html#proto-rvp" target="_blank">JXTA Protocols Specification : Rendezvous Protocol
     **/
    private StdRdvProtocolListener      handler;
    
    protected final Timer               timer;
    
    /**
     *  Interface for listeners to : &lt;assignedID>/<group-unique>
     **/
    protected interface StdRdvProtocolListener extends EndpointListener {}
    
    /**
     * Constructor
     **/
    protected StdRendezVousService(PeerGroup group, RendezVousServiceImpl rdvService) {
        
        super(group, rdvService);
        
        MAX_TTL = DEFAULT_MAX_TTL;
        
        pName = rdvService.getAssignedID().toString();
        pParam = group.getPeerGroupID().getUniqueValue().toString();
        
        timer = new Timer(true);
        timer.schedule(new TimerThreadNamer("StdRendezVousService Timer for " + group.getPeerGroupID()), 0);
    }
    
    /**
     * @inheritDoc
     **/
    protected int startApp(String[] argv, StdRdvProtocolListener handler) {
        
        this.handler = handler;
        
        rdvService.endpoint.addIncomingMessageListener(handler, pName, null);
        
        return super.startApp(argv);
    }
    
    /**
     * @inheritDoc
     **/
    protected void stopApp() {
        EndpointListener shouldbehandler = rdvService.endpoint.removeIncomingMessageListener(pName, null);
        
        if (handler != shouldbehandler) {
            if (LOG.isEnabledFor(Level.WARN)) {
                LOG.warn("Unregistered listener was not as expected." + handler + " != " + shouldbehandler);
            }
        }
        
        timer.cancel();
        
        super.stopApp();
    }
    
    /**
     * Receive and publish a Rendezvous Peer Advertisement.
     *
     * @param  msg  Message containing the Rendezvous Peer Advertisement
     **/
    protected void processRdvAdvReply(Message msg) {
        
        try {
            MessageElement elem = msg.getMessageElement("jxta", RdvAdvReply);
            
            if (null != elem) {
                XMLDocument doc = (XMLDocument) StructuredDocumentFactory.newStructuredDocument( elem );
                
                PeerAdvertisement adv = (PeerAdvertisement) AdvertisementFactory.newAdvertisement(doc);
                
                DiscoveryService discovery = group.getDiscoveryService();
                
                if (null != discovery) {
                    discovery.publish(adv, DiscoveryService.DEFAULT_EXPIRATION, DiscoveryService.DEFAULT_EXPIRATION);
                }
            }
        } catch (Exception failed) {
            if (LOG.isEnabledFor(Level.DEBUG)) {
                LOG.debug("Publish Rdv Adv failed", failed);
            }
        }
    }
    
    /**
     *  {@inheritDoc}
     **/
    public void processReceivedMessage(Message message, RendezVousPropagateMessage propHdr, EndpointAddress srcAddr, EndpointAddress dstAddr) {
        
        if (srcAddr.getProtocolName().equalsIgnoreCase("jxta")) {
            String idstr = ID.URIEncodingName + ":" + ID.URNNamespace + ":" + srcAddr.getProtocolAddress();
            
            PeerID peerid = null;
            
            try {
                peerid = (PeerID) IDFactory.fromURI(new URI(idstr));
            } catch (URISyntaxException badID) {
                if (LOG.isEnabledFor(Level.WARN)) {
                    LOG.warn("Bad ID in message", badID);
                }
                return;
            } catch (ClassCastException badID) {
                if (LOG.isEnabledFor(Level.WARN)) {
                    LOG.warn("ID is not a peer id", badID);
                }
                return;
            }
            
            if (!group.getPeerID().equals(peerid)) {
                PeerConnection pConn = getPeerConnection(peerid);
                
                if (null == pConn) {
                    PeerViewElement pve = rdvService.rpv.getPeerViewElement(peerid);
                    
                    if (null == pve) {
                        if (LOG.isEnabledFor(Level.DEBUG)) {
                            LOG.debug("Received " + message + " (" + propHdr.getMsgId() + ") from unrecognized peer : " + peerid);
                        }
                        
                        propHdr.setTTL(Math.min(propHdr.getTTL(), 3)); // will be reduced during repropagate stage.
                        
                        // FIXME 20040503 bondolo need to add tombstones so that we don't end up spamming disconnects.
                        if (rdvService.isRendezVous() || (getPeerConnections().length > 0)) {
                            // edge peers with no rdv should not send disconnect.
                            sendDisconnect(peerid, null);