relayreferralseedingmanager.java

JXTA&#8482 is a set of open, generalized peer-to-peer (P2P) protocols that allow any networked devi

/*
 * Copyright (c) 2002-2004 Sun Microsystems, Inc.  All rights reserved.
 *  
 *  The Sun Project JXTA(TM) Software License
 *  
 *  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 Sun Microsystems, Inc. for JXTA(TM) technology." 
 *     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.
 *  
 *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United 
 *  States and other countries.
 *  
 *  Please see the license information page at :
 *  <http://www.jxta.org/project/www/license.html> for instructions on use of 
 *  the license in source files.
 *  
 *  ====================================================================
 *  
 *  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.endpoint.relay;

import net.jxta.endpoint.EndpointService;
import net.jxta.endpoint.MessageTransport;
import net.jxta.logging.Logging;
import net.jxta.peergroup.PeerGroup;
import net.jxta.protocol.RouteAdvertisement;

import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.jxta.endpoint.EndpointAddress;
import net.jxta.impl.util.URISeedingManager;

/**
 *  Extends the URI Seeding Manager by supplementing the list of active seeds
 *  with the active relay peers.
 */
public class RelayReferralSeedingManager extends URISeedingManager {
    
    /**
     * Logger
     */
    private static final transient Logger LOG = Logger.getLogger(RelayReferralSeedingManager.class.getName());

    private final PeerGroup group;
    
    /**
     *  Get an instance of RelayReferralSeedingManager.
     *
     * @param aclLocation acl URI
     * @param allowOnlySeeds if <code>true</code> allow only seeds
     * @param group the peer group
     * @param serviceName Service name
     */
    public RelayReferralSeedingManager(URI aclLocation, boolean allowOnlySeeds, PeerGroup group, String serviceName) {
        super(aclLocation, allowOnlySeeds, group, serviceName);
        this.group = group;
    }
    
    /**
     *  {@inheritDoc}
     */
    @Override
    public synchronized URI[] getActiveSeedURIs() {
        Collection<URI> result = new ArrayList<URI>();
        Collection<RouteAdvertisement> relays = getRelayPeers();
        
        int eaIndex = 0;
        boolean addedEA;
        
        do {
            addedEA = false;
            
            for (RouteAdvertisement aRA : relays) {
                List<EndpointAddress> raEAs = aRA.getDestEndpointAddresses();
                if (eaIndex < raEAs.size()) {
                    URI seedURI = raEAs.get(eaIndex).toURI();
                    if(!result.contains(seedURI)) {
                        result.add(seedURI);
                    }
                    addedEA = true;
                }
            }
            
            // Next loop we use the next most preferred address.
            eaIndex++;
        } while (addedEA);
        
        // Add the non-relay seeds afterwards.
        for(URI eachURI : Arrays.asList(super.getActiveSeedURIs())) {
            if(!result.contains(eachURI)) {
                result.add(eachURI);
            }
        }
                
        return result.toArray(new URI[result.size()]);
    }

    /**
     *  {@inheritDoc}
     */
    @Override
    public synchronized RouteAdvertisement[] getActiveSeedRoutes() {
        List<RouteAdvertisement> result = new ArrayList<RouteAdvertisement>(getRelayPeers());
        
            for(RouteAdvertisement eachRoute : Arrays.asList(super.getActiveSeedRoutes())) {
                if(!result.contains(eachRoute)) {
                    result.add(eachRoute);
                }
            }
        return result.toArray(new RouteAdvertisement[result.size()]);
    }
    
    /**
     *  @return List of RouteAdvertisement
     */
    private Collection<RouteAdvertisement> getRelayPeers() {
        Collection<RouteAdvertisement> result = new ArrayList<RouteAdvertisement>();
        
        try {
            EndpointService ep = group.getEndpointService();
            
            Iterator it = ep.getAllMessageTransports();
            
            while (it.hasNext()) {
                MessageTransport mt = (MessageTransport) it.next();
                
                if (!mt.getEndpointService().getGroup().getPeerGroupID().equals(group.getPeerGroupID())) {
                    // We only want relay services in this peer group.
                    continue;
                }
                
                if (mt instanceof RelayClient) {
                    RelayClient er = (RelayClient) mt;
                    
                    RelayClient.RelayServerConnection current = er.currentServer;
                    
                    if (null == current) {
                        continue;
                    }
                    
                    RouteAdvertisement rdvAdv = current.relayAdv;

                    if (null == rdvAdv) {
                        continue;
                    }

                    result.add(rdvAdv.clone());
                }
            }
        } catch (Exception ez1) {
            if (Logging.SHOW_WARNING && LOG.isLoggable(Level.WARNING)) {
                LOG.log(Level.WARNING, "Unexpected error getting relays", ez1);
            }
        }
        
        if (Logging.SHOW_FINE && LOG.isLoggable(Level.FINE)) {
            LOG.fine("Found " + result.size() + " relay seeds.");
        }
        return result;
    }
}