iputils.java

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

/*
 * Copyright (c) 2001-2007 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;


import java.io.IOException;
import java.net.BindException;
import java.net.Inet6Address;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.NetworkInterface;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.SocketException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.List;
import java.util.Random;
import javax.net.ServerSocketFactory;

import java.util.logging.Level;
import net.jxta.logging.Logging;
import java.util.logging.Logger;


/**
 * Utility methods for use by IP based transports.
 */
public final class IPUtils {
    
    /**
     * Logger
     */
    private final static Logger LOG = Logger.getLogger(IPUtils.class.getName());
    
    final static Random random = new Random();
    
    final static String IPV4ANYADDRESS = "0.0.0.0";
    final static String IPV6ANYADDRESS = "::";
    
    final static String IPV4LOOPBACK = "127.0.0.1";
    final static String IPV6LOOPBACK = "::1";
    
    /**
     * Constant which works as the IP "Any Address" value
     */
    public final static InetAddress ANYADDRESS;
    public final static InetAddress ANYADDRESSV4;
    public final static InetAddress ANYADDRESSV6;
    
    /**
     * Constant which works as the IP "Local Loopback" value;
     */
    public final static InetAddress LOOPBACK;
    public final static InetAddress LOOPBACKV4;
    public final static InetAddress LOOPBACKV6;
    
    /**
     * Socket factory to allow changing the way Sockets are created
     * and connected.  A null value is ok and results in the regular
     * connectToFromNoFactory being used.
     *
     * <p/>Plugin in a different implementation via setSocketFactory().
     */
    private static SocketFactory socketFactory;
    
    /**
     * Socket factory to allow changing the way Sockets are created
     * and connected.  A null value is ok and results in the regular
     * connectToFromNoFactory being used.
     *
     * <p/>Plugin in a different implementation via setSocketFactory().
     */
    private static ServerSocketFactory serverSocketFactory;
    
    static {
        InetAddress GET_ADDRESS = null;
        
        try {
            GET_ADDRESS = InetAddress.getByName(IPV4ANYADDRESS);
        } catch (Exception ignored) {
            if (Logging.SHOW_WARNING && LOG.isLoggable(Level.WARNING)) {
                LOG.warning("failed to intialize ANYADDRESSV4. Not fatal");
            }
        }
        
        ANYADDRESSV4 = GET_ADDRESS;

        InetAddress GET_ANYADDRESSV6 = null;

        GET_ADDRESS = null;
        try {
            GET_ADDRESS = InetAddress.getByName(IPV6ANYADDRESS);
        } catch (Exception ignored) {
            if (Logging.SHOW_WARNING && LOG.isLoggable(Level.WARNING)) {
                LOG.warning("failed to intialize IPV6ANYADDRESS. Not fatal");
            }
        }
        
        ANYADDRESSV6 = GET_ADDRESS;
        
        ANYADDRESS = (ANYADDRESSV4 == null) ? ANYADDRESSV6 : ANYADDRESSV4;
        
        GET_ADDRESS = null;
        try {
            GET_ADDRESS = InetAddress.getByName(IPV4LOOPBACK);
        } catch (Exception ignored) {
            if (Logging.SHOW_WARNING && LOG.isLoggable(Level.WARNING)) {
                LOG.warning("failed to intialize IPV4LOOPBACK. Not fatal");
            }
        }
        
        LOOPBACKV4 = GET_ADDRESS;
        
        GET_ADDRESS = null;
        try {
            GET_ADDRESS = InetAddress.getByName(IPV6LOOPBACK);
        } catch (Exception ignored) {
            if (Logging.SHOW_WARNING && LOG.isLoggable(Level.WARNING)) {
                LOG.warning("failed to intialize ANYADDRESSV4. Not fatal");
            }
        }
        
        LOOPBACKV6 = GET_ADDRESS;
        
        LOOPBACK = (LOOPBACKV4 == null) ? LOOPBACKV6 : LOOPBACKV4;
        
        if (LOOPBACK == null || ANYADDRESS == null) {
            if (Logging.SHOW_SEVERE && LOG.isLoggable(Level.SEVERE)) {
                LOG.severe("failure initializing statics. Neither IPV4 nor IPV6 seem to work.");
            }
            
            throw new IllegalStateException("failure initializing statics. Neither IPV4 nor IPV6 seem to work.");
        }
    }
    
    /**
     * This is a static utility class, you don't make instances.
     */
    private IPUtils() {}
    
    /**
     * Provide an iterator which returns all of the local InetAddresses for this
     * host.
     *
     * @return iterator of InetAddress which is all of the InetAddress for all
     *         local interfaces.
     */
    public static Iterator<InetAddress> getAllLocalAddresses() {
        List<InetAddress> allAddr = new ArrayList<InetAddress>();
        
        Enumeration<NetworkInterface> allInterfaces = null;

        try {
            allInterfaces = NetworkInterface.getNetworkInterfaces();
        } catch (SocketException caught) {
            if (Logging.SHOW_SEVERE && LOG.isLoggable(Level.SEVERE)) {
                LOG.log(Level.SEVERE, "Could not get local interfaces list", caught);
            }
        }
        
        if (null == allInterfaces) {
            allInterfaces = Collections.enumeration(Collections.<NetworkInterface>emptyList());
        }
        
        while (allInterfaces.hasMoreElements()) {
            NetworkInterface anInterface = allInterfaces.nextElement();
            
            try {
                Enumeration<InetAddress> allIntfAddr = anInterface.getInetAddresses();
                
                while (allIntfAddr.hasMoreElements()) {
                    InetAddress anAddr = allIntfAddr.nextElement();
                    
                    if (anAddr.isLoopbackAddress() || anAddr.isAnyLocalAddress()) {
                        continue;
                    }
                    
                    if (!allAddr.contains(anAddr)) {
                        allAddr.add(anAddr);
                    }
                }
            } catch (Throwable caught) {
                if (Logging.SHOW_SEVERE && LOG.isLoggable(Level.SEVERE)) {
                    LOG.log(Level.SEVERE, "Could not get addresses for " + anInterface, caught);
                }
            }
        }
        
        // if nothing suitable was found then return loopback address.
        if (allAddr.isEmpty() || Boolean.getBoolean("net.jxta.impl.IPUtils.localOnly")) {
            if (null != LOOPBACKV4) {
                allAddr.add(LOOPBACKV4);
            }
            
            if (null != LOOPBACKV6) {
                allAddr.add(LOOPBACKV6);
            }
            
            if (Logging.SHOW_FINE && LOG.isLoggable(Level.FINE)) {