All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.jxta.peergroup.WorldPeerGroupFactory Maven / Gradle / Ivy

/*
 * 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 :
 *   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.peergroup;


import net.jxta.exception.ConfiguratorException;
import net.jxta.exception.PeerGroupException;
import net.jxta.logging.Logging;
import net.jxta.protocol.ConfigParams;

import java.io.File;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.net.URI;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.jxta.platform.JxtaLoader;
import net.jxta.protocol.ModuleImplAdvertisement;


/**
 * A factory for instantiating the World Peer Group. Every peer starts by
 * instantiating the World Peer Group and then other Peer Groups are
 * instantiated as needed. Most applications do not need to use 
 * {@code WorldPeerGroupFactory} but should instead prefer using
 * {@code NetPeerGroupFactory} whenever possible.
 * 

* The World Peer Group provides the minimum core services needed to find * and instantiate other Peer Groups on a peer. The World Peer Group is the * primordial peer group upon which all other peer groups are instantiated. The * World Peer Group is primarily responsible for management of physical network * connections, physical network discovery (generally broadcast) and physical * network topology management. *

* Applications generally do not normally interact directly with the World Peer * Group. The World Peer Group includes only limited endpoint, resolver, * discovery and rendezvous services. *

* When the World Peer Group starts it may optionally search * for The Network Peer Group on the local network and, if found, * instantiate it. Otherwise a default built-in configuration of The Net * Peer Group is instantiated. * * @since JXTA JSE 2.4 * * @see net.jxta.peergroup.PeerGroup * @see net.jxta.peergroup.NetPeerGroupFactory */ public final class WorldPeerGroupFactory { /** * Logger */ private final static transient Logger LOG = Logger.getLogger(WorldPeerGroupFactory.class.getName()); /** * Our strong reference to the World Peer Group. */ private final PeerGroup world; /** * Provided for backwards compatibility, this constructor instantiates the * World Peer Group using the PlatformConfig file found in the directory * specified by the {@code JXTA_HOME} system property or the "{@code .jxta/}" * directory if {@code JXTA_HOME} is not defined. *

* Though not deprecated this method should be considered as sample * code only and the other constructors should be used whenever possible. * * @throws PeerGroupException Thrown for problems construction the World * Peer Group. */ public WorldPeerGroupFactory() throws PeerGroupException { // Establish the default store location via long established hackery. String jxta_home = System.getProperty("JXTA_HOME", ".jxta/"); // ensure that it ends in a seperator. if (!jxta_home.endsWith(File.separator)) { jxta_home += File.separator; } File jxta_home_dir = new File(jxta_home); // Ensure the homedir exists. if (!jxta_home_dir.exists()) { jxta_home_dir.mkdirs(); } URI storeHome = jxta_home_dir.toURI(); // Instantiate the default configurator. Do not do this in your own code! try { Configurator configurator = new net.jxta.impl.peergroup.DefaultConfigurator(storeHome); // Get (and possibly generate) the platform configuration. ConfigParams config = configurator.getConfigParams(); world = newWorldPeerGroup(getDefaultWorldPeerGroupClass(), config, storeHome); // persist any changes which were made to the platform config by // service initialization. configurator.setConfigParams(config); configurator.save(); } catch (ConfiguratorException configFailure) { LOG.severe("Failure while managing World Peer Group configuration"); throw new PeerGroupException("Failure while managing World Peer Group configuration", configFailure); } } /** * Constructs the World Peer Group using the specified configuration and * using the specified storeHome location for persistence. * * @param config The configuration to use for the World Peer Group. * @param storeHome The optional location that the World Peer Group and its' * services should use for storing persistent and transient information. * May be null if the World Peer Group is not provided a * persistent store (though this not currently supported). * @throws PeerGroupException Thrown for problems constructing the World * Peer Group. */ public WorldPeerGroupFactory(ConfigParams config, URI storeHome) throws PeerGroupException { world = newWorldPeerGroup(getDefaultWorldPeerGroupClass(), config, storeHome); } /** * Constructs the World Peer Group using the specified configuration and * using the specified storeHome location for persistence. * * @param worldPeerGroupClass The class which will be instantiated for the * World Peer Group instance. * @param config The configuration to use for the World Peer Group. * @param storeHome The optional location that the World Peer Group and its' * services should use for storing persistent and transient information. * May be null if the World Peer Group is not provided a * persistent store (though this not currently supported). * @throws PeerGroupException Thrown for problems constructing the World * Peer Group. */ public WorldPeerGroupFactory(Class worldPeerGroupClass, ConfigParams config, URI storeHome) throws PeerGroupException { world = newWorldPeerGroup(worldPeerGroupClass, config, storeHome); } /** * Returns a strong (reference counted) interface object for the World Peer * Group. This reference should be explicitly unreferenced when it is no * longer needed. * * @return A strong (reference counted) interface object for the World Peer * Group. * @see PeerGroup#unref() */ public PeerGroup getInterface() { return (PeerGroup) world.getInterface(); } /** * Returns a weak (non-reference counted) interface object for the World * Peer Group. * * @return A weak (non-reference counted) interface object for the World * Peer Group. * @see PeerGroup#getWeakInterface() */ public PeerGroup getWeakInterface() { return world.getWeakInterface(); } /** * Determine the class to use for the World PeeerGroup. * * @return The Class which has been configured to be used for * World Peer Group instances. * @throws PeerGroupException Thrown for problems determining the class to * be used for the World Peer Group. */ private static Class getDefaultWorldPeerGroupClass() throws PeerGroupException { try { // XXX 20070713 bondolo Temporary hack to resolve class load order issue. StdPeerGroup is responsible for initializing standard modules. String unused = net.jxta.impl.peergroup.StdPeerGroup.STD_COMPAT.toString(); JxtaLoader loader = net.jxta.impl.peergroup.GenericPeerGroup.getJxtaLoader(); ModuleImplAdvertisement worldGroupImplAdv = loader.findModuleImplAdvertisement(PeerGroup.refPlatformSpecID); if(null == worldGroupImplAdv) { throw new PeerGroupException("Could not locate World PeerGroup Module Implementation."); } return Class.forName(worldGroupImplAdv.getCode()); } catch (RuntimeException failed) { throw new PeerGroupException("Could not load World PeerGroup class.", failed); } catch (ClassNotFoundException failed) { throw new PeerGroupException("Could not load World PeerGroup class.", failed); } } /** * Constructs the World Peer Group instance. * * @param worldPeerGroupClass The class which will be instantiated for the * World Peer Group instance. * @param config The configuration to use for the World Peer Group. * @param storeHome The optional location the World Peer Group and its' * services may use for storing persistent and transient information. * May be {@code null} if the World Peer Group is not provided a * persistent store (though this not currently supported). * @throws PeerGroupException Thrown for problems constructing the World * Peer Group. * @return the WorldPeerGroup */ private PeerGroup newWorldPeerGroup(Class worldPeerGroupClass, ConfigParams config, URI storeHome) throws PeerGroupException { if (!storeHome.isAbsolute()) { LOG.severe("storeHome must be an absolute URI."); throw new PeerGroupException("storeHome must be an absolute URI."); } if (storeHome.isOpaque()) { LOG.severe("Opaque storeHome is not currently supported."); throw new PeerGroupException("Opaque storeHome is not currently supported."); } synchronized (PeerGroup.globalRegistry) { if (PeerGroup.globalRegistry.registeredInstance(PeerGroupID.worldPeerGroupID)) { throw new PeerGroupException( "Only a single instance of the World Peer Group may be instantiated at a single time."); } PeerGroup result = null; try { if (Logging.SHOW_INFO && LOG.isLoggable(Level.INFO)) { LOG.info("Making a new World Peer Group instance using : " + worldPeerGroupClass.getName()); } Constructor twoParams = (Constructor) worldPeerGroupClass.getConstructor(ConfigParams.class,URI.class); try { result = twoParams.newInstance(config, storeHome); } catch (InvocationTargetException failure) { // unwrap the real exception. Throwable cause = failure.getCause(); if (cause instanceof Exception) { throw (Exception) cause; } else if (cause instanceof Error) { throw (Error) cause; } else { // just rethrow what we already had. sigh. throw failure; } } result.init(null, PeerGroupID.worldPeerGroupID, null); return result; } catch (RuntimeException e) { // should be all other checked exceptions LOG.log(Level.SEVERE, "World Peer Group could not be instantiated.", e); // cleanup broken instance if (null != result) { result.unref(); } // just rethrow. throw e; } catch (Exception e) { // should be all other checked exceptions LOG.log(Level.SEVERE, "World Peer Group could not be instantiated.", e); // cleanup broken instance if (null != result) { result.unref(); } // Simplify exception scheme for caller: any sort of problem wrapped // in a PeerGroupException. throw new PeerGroupException("World Peer Group could not be instantiated.", e); } } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy