Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Project JXTA
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

net.jxta.impl.peergroup
Interface PlatformConfigurator

All Superinterfaces:
Configurator
All Known Implementing Classes:
AbstractConfigurator, Configurator, DefaultConfigurator, NullConfigurator, TrivialConfigurator
public interface PlatformConfigurator
extends Configurator

Defines a configurator for the JXTA Platform peer group.

Author:
james todd [gonzo at jxta dot org]

Method Summary
 URI getJXTAHome()
           
 PlatformConfig getPlatformConfig()
          Retrieve the associated PlatformConfig and potentially reconfigure the parameters before returning.
 boolean isReconfigure()
          Determine if a forced reconfiguration is set for the next call to getPlatformConfig().
 PlatformConfig load(File f)
          Deprecated. Sub-classes should devise their own, more appropriate method.
 boolean save(File f)
          Deprecated. Sub-classes should devise their own, more appropriate method.
 void setPlatformConfig(PlatformConfig pc)
          Sets the associated PlatformConfig.
 void setReconfigure(boolean forceReconfig)
          Sets the reconfiguration status to the specified status.
 
Methods inherited from interface net.jxta.peergroup.Configurator
getConfigParams, load, save, setConfigParams
 

Method Detail

getJXTAHome

URI getJXTAHome()

getPlatformConfig

PlatformConfig getPlatformConfig()
                                 throws ConfiguratorException
Retrieve the associated PlatformConfig and potentially reconfigure the parameters before returning.

Returns:
PlatformConfig
Throws:
ConfiguratorException

setPlatformConfig

void setPlatformConfig(PlatformConfig pc)
Sets the associated PlatformConfig.

Parameters:
pc -

load

PlatformConfig load(File f)
                    throws ConfiguratorException
Deprecated. Sub-classes should devise their own, more appropriate method.

Persist the associated{ @link net.jxta.impl.protocol.PlatformConfig} to the specified location.

Parameters:
f - The file to which the configuration will be saved.
Returns:
true if the configuration was successfully saved otherwise false. If the parameters are not persisted then false/code> is returned.
Throws:
ConfiguratorException

save

boolean save(File f)
             throws ConfiguratorException
Deprecated. Sub-classes should devise their own, more appropriate method.

Persist the associated{ @link net.jxta.impl.protocol.PlatformConfig} to the specified location.

Parameters:
f - The file to which the configuration will be saved.
Returns:
true if the configuration was successfully saved otherwise false. If the parameters are not persisted then false/code> is returned.
Throws:
ConfiguratorException

setReconfigure

void setReconfigure(boolean forceReconfig)
Sets the reconfiguration status to the specified status. If true then reconfiguration will be forced the next time the PlatformConfig is retrieved.

Parameters:
forceReconfig - If true then a forced reconfiguration will occur the next time getPlatformConfig() is called.

isReconfigure

boolean isReconfigure()
Determine if a forced reconfiguration is set for the next call to getPlatformConfig().

Returns:
Returns true if a forced reconfiguration will occur the next time getPlatformConfig() is called.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
JXTA J2SE
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD