sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/impl/src/net/jxta/impl/peergroup/PlatformConfigurator.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56 package net.jxta.impl.peergroup;
  57
  58
  59 import net.jxta.exception.ConfiguratorException;
  60 import net.jxta.impl.protocol.PlatformConfig;
  61 import net.jxta.peergroup.Configurator;
  62
  63
  64 /**
  65  * Defines a configurator for the JXTA Platform peer group.
  66  *
  67  * @deprecated This interface has been replaced with the {@link net.jxta.platform.NetworkConfigurator}.
  68  */
  69 @Deprecated
  70 public interface PlatformConfigurator extends Configurator {
  71
  72     /**
  73      * Retrieve the associated {@link net.jxta.impl.protocol.PlatformConfig} and
  74      * potentially performing any required configuration of the parameters
  75      * before returning.
  76      *
  77      * @return PlatformConfig
  78      * @throws net.jxta.exception.ConfiguratorException If configuration error
  79      * occurs.
  80      */
  81     public PlatformConfig getPlatformConfig() throws ConfiguratorException;
  82
  83     /**
  84      * Sets the associated {@link net.jxta.impl.protocol.PlatformConfig}.
  85      *
  86      * @param pc the configuration
  87      */
  88     public void setPlatformConfig(PlatformConfig pc);
  89
  90     /**
  91      * Sets the reconfiguration status to the specified status. If
  92      * {@code true} then reconfiguration will be forced the next time the
  93      * {@link net.jxta.impl.protocol.PlatformConfig} is retrieved.
  94      *
  95      * @param forceReconfig If {@code true} then a forced reconfiguration will
  96      * occur the next time {@link #getPlatformConfig()} is called.
  97      */
  98     public void setReconfigure(boolean forceReconfig);
  99
 100     /**
 101      * Determine if a forced reconfiguration is set for the next call to
 102      * {@link #getPlatformConfig()}.
 103      *
 104      * @return Returns {@code true} if a forced reconfiguration will occur the
 105      * next time {@link #getPlatformConfig()} is called.
 106      */
 107     public boolean isReconfigure();
 108 }