rdvconfigadv.java

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

/*
 * Copyright (c) 2004 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: RdvConfigAdv.java,v 1.12 2006/01/05 22:13:35 bondolo Exp $
 */

package net.jxta.impl.protocol;


import java.net.URI;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.Set;
import java.util.HashSet;

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

import net.jxta.document.Advertisement;
import net.jxta.document.Attributable;
import net.jxta.document.Attribute;
import net.jxta.document.Document;
import net.jxta.document.Element;
import net.jxta.document.ExtendableAdvertisement;
import net.jxta.document.MimeMediaType;
import net.jxta.document.StructuredDocument;
import net.jxta.document.XMLElement;
import net.jxta.document.AdvertisementFactory;
import net.jxta.id.ID;


/**
 * Contains parameters for configuration of the Reference Implementation
 * Rendezvous Service.
 *
 * <p/><pre><code>
 * &lt;xs:complexType name="RdvConfig">
 *   &lt;xs:sequence>
 *     &lt;xs:element name="seeds" minOccurs="0" maxOccurs="1">
 *       &lt;xs:complexType>
 *         &lt;xs:sequence>
 *           &lt;xs:element name="addr" minOccurs="1" maxOccurs="unbounded">
 *             &lt;xs:complexType>
 *               &lt;xs:simpleContent>
 *                 &lt;xs:extension base="jxta:JXTAID">
 *                   &lt;xs:attribute name="seeding" type="xs:boolean" default="false"/>
 *                 &lt;/xs:extension>
 *               &lt;/xs:simpleContent>
 *             &lt;/xs:complexType>
 *           &lt;/xs:element>
 *         &lt;/xs:sequence>
 *         &lt;xs:attribute name="useOnlySeeds" type="xs:boolean" default="false"/>
 *         &lt;xs:attribute name="connectDelay" type="xs:unsignedLong"/>
 *       &lt;/xs:complexType>
 *     &lt;/xs:element>
 *   &lt;/xs:sequence>
 *   &lt;xs:attribute name="config" type="jxta:RdvConfiguration"/>
 *   &lt;xs:attribute name="maxTTL" type="xs:unsignedInt"/>
 *   &lt;xs:attribute name="autoRendezvousInterval" type="xs:unsignedInt"/>
 *   &lt;xs:attribute name="probeRelays" type="xs:boolean" default="true"/>
 *   &lt;xs:attribute name="maxClients" type="xs:unsignedInt"/>
 *   &lt;xs:attribute name="leaseDuration" type="xs:unsignedLong"/>
 *   &lt;xs:attribute name="leaseMargin" type="xs:unsignedLong"/>
 *   &lt;xs:attribute name="minHappyPeerView" type="xs:unsignedInt"/>
 * &lt;/xs:complexType>
 * </code></pre>
 *
 *  @since JXTA 2.2
 *
 **/
public final class RdvConfigAdv extends ExtendableAdvertisement {
    
    /**
     *  Log4J Logger
     **/
    private static final Logger LOG = Logger.getLogger(RdvConfigAdv.class.getName());
    
    /**
     *  Instantiator for RdvConfigAdv
     **/
    public static class Instantiator implements AdvertisementFactory.Instantiator {
        
        /**
         * {@inheritDoc}
         **/
        public String getAdvertisementType() {
            return advType;
        }
        
        /**
         * {@inheritDoc}
         **/
        public Advertisement newInstance() {
            return new RdvConfigAdv();
        }
        
        /**
         * {@inheritDoc}
         **/
        public Advertisement newInstance(Element root) {
            return new RdvConfigAdv(root);
        }
    }
    
    /**
     *  Our DOCTYPE
     **/
    private static final String advType = "jxta:RdvConfig";
    
    private static final String RDV_CONFIG_ATTR = "config";
    private static final String MAX_TTL_ATTR = "maxTTL";
    private static final String AUTO_RDV_INTERVAL_ATTR = "autoRendezvousInterval";
    private static final String PROBE_RELAYS_ATTR = "probeRelays";
    private static final String MAX_CLIENTS_ATTR = "maxClients";
    private static final String LEASE_DURATION_ATTR = "leaseDuration";
    private static final String LEASE_MARGIN_ATTR = "leaseMargin";
    private static final String MIN_HAPPY_PEERVIEW_ATTR = "minHappyPeerView";
    
    private static final String SEEDS_RDV_ELEMENT = "seeds";
    private static final String USE_ONLY_SEEDS_ATTR = "useOnlySeeds";
    private static final String CONNECT_DELAY_ATTR = "connectDelay";
    
    private static final String SEED_RDV_ADDR_ELEMENT = "addr";
    private static final String SEED_RDV_ADDR_SEEDING_ATTR = "seeding";
    
    // This one is deprecated.
    private static final String PROPAGATE_RESPOND_ATTR = "propagateRespondProbability";
    
    private static final String[] INDEXFIELDS = {};
    
    /**
     *  Configuration for this peer.
     **/
    private RendezVousConfiguration configuration = RendezVousConfiguration.EDGE;
    
    /**
     * The interval in relative milliseconds at which this peer will re-evaluate
     * it's state as a rendezvous. If <code>0</code> (zero), the default, then
     * the peer will remain in the state of <code>isRendezvous</code>.
     **/
    private long autoRendezvousCheckInterval = 0L;
    
    /**
     *  If true then rendezvous clients will probe relay servers for rendezvous.
     **/
    private boolean probeRelays = true;
    
    /**
     *  Max Clients
     **/
    private int maxClients = -1;
    
    /**
     *  Maximum TTL
     **/
    private int maximumTTL = -1;
    
    /**
     *  Lease Duration
     **/
    private long leaseDuration = 0L;
    
    /**
     *  Lease Margin
     **/
    private long leaseMargin = 0L;
    
    /**
     * Minimum desirable peerview size.
     **/
    private int minHappyPeerView = -1;
    
    /**
     * If true then this peer will use only seed rendezvous when configured as
     * an edge peer.
     **/
    private boolean useOnlySeeds = false;
    
    /**
     *  The interval in relative milliseconds before which this peer will
     *  attempt to contact the the seed peers.
     **/
    private long seedRendezvousConnectDelay = 0L;
    
    /**
     *  The set of seed rendezvous.
     *
     *  <p/><ul>
     *      <li>The values are {@link java.net.URI}.</li>
     *  </ul>
     **/
    private Set seedRendezvous = new HashSet();
    
    /**
     *  The set of seeding resources.
     *
     *  <p/><ul>
     *      <li>The values are {@link java.net.URI}.</li>
     *  </ul>
     **/
    private Set seedingURIs = new HashSet();
    
    /**
     *  Enumeration of possible Rendezvous configurations.
     **/
    public abstract static class RendezVousConfiguration {
        
        public static final RendezVousConfiguration AD_HOC = new RendezVousConfiguration() {
            
            public String toString() {
                return "AD HOC";
            }
        };
        
        public static final RendezVousConfiguration EDGE = new RendezVousConfiguration() {
            
            public String toString() {
                return "EDGE";
            }
        };
        
        public static final RendezVousConfiguration RENDEZVOUS = new RendezVousConfiguration() {
            
            public String toString() {
                return "RENDEZVOUS";
            }
        };
        
        private RendezVousConfiguration() {}
    }
    
    /**
     *  Returns the identifying type of this Advertisement.
     *
     *  <p/><b>Note:</b> This is a static method. It cannot be used to determine
     *  the runtime type of an advertisment. ie.
     *  </p><code><pre>
     *      Advertisement adv = module.getSomeAdv();
     *      String advType = adv.getAdvertisementType();
     *  </pre></code>
     *
     *  <p/><b>This is wrong and does not work the way you might expect.</b>
     *  This call is not polymorphic and calls
     *  Advertiement.getAdvertisementType() no matter what the real type of the
     *  advertisment.
     *
     * @return String the type of advertisement
     **/
    public static String getAdvertisementType() {
        return advType;
    }
    
    /**
     *  Use the Instantiator through the factory
     **/
    RdvConfigAdv() {}
    
    /**
     *  Use the Instantiator through the factory
     **/
    RdvConfigAdv(Element root) {
        if (!XMLElement.class.isInstance(root)) {
            throw new IllegalArgumentException(getClass().getName() + " only supports XLMElement");
        }
        
        XMLElement doc = (XMLElement) root;
        
        String doctype = doc.getName();