Project JXTA

net.jxta.peergroup
Class PeerGroupFactory

java.lang.Object
  |
  +--net.jxta.peergroup.PeerGroupFactory

public class PeerGroupFactory
extends java.lang.Object

Factory Classes to create a new Peer Platform and New PeerGroups. This class is used by Jxta applications to create new groups

JXTA comes with two subclasses of peer groups:

The Platform group is created via the newPlatform method. The Net Peer Group and user Peer Groups are created via the newPeerGroup method.

Since:
JXTA 1.0
See Also:
PeerGroup

Constructor Summary
PeerGroupFactory()
           
 
Method Summary
static PeerGroup newNetPeerGroup(PeerGroup pg)
          Until the concept of netPeerGroup is better integrated, we need something straightforward so that applications that whish to control the start-up process can easily bring up a netPeerGroup like startNetPeerGroup does.
static PeerGroup newPeerGroup()
          Static Method to create a new peer group instance.
static PeerGroup newPeerGroup(PeerGroup parent, Advertisement adv)
          Static Method to create a new PeerGroup instance, given its parameters.
static PeerGroup newPlatform()
          Static Method to create a new peer Plaform The init() method is called automatically.
static void setPlatformClass(java.lang.Class c)
          Static Method to initialize the Platform peergroup class
static void setStdPeerGroupClass(java.lang.Class c)
          Static Method to initialize the std peer group class
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PeerGroupFactory

public PeerGroupFactory()
Method Detail

setStdPeerGroupClass

public static void setStdPeerGroupClass(java.lang.Class c)
Static Method to initialize the std peer group class
Parameters:
Class - name to be initialized in the factory
Since:
JXTA 1.0

setPlatformClass

public static void setPlatformClass(java.lang.Class c)
Static Method to initialize the Platform peergroup class
Parameters:
Class - name of the class implementing platform
Since:
JXTA 1.0

newPeerGroup

public static PeerGroup newPeerGroup()
Static Method to create a new peer group instance. After beeing created the init method needs to be called, and the startApp() method may be called, at the invoker's discretion.
Returns:
PeerGroup instance of a new PeerGroup
Since:
JXTA 1.0

newPeerGroup

public static PeerGroup newPeerGroup(PeerGroup parent,
                                     Advertisement adv)
                              throws PeerGroupException
Static Method to create a new PeerGroup instance, given its parameters. The startApp() method is left for the invoker's to call if appropriate.
Returns:
PeerGroup instance of a new PeerGroup
Since:
JXTA 1.0

newPlatform

public static PeerGroup newPlatform()
Static Method to create a new peer Plaform The init() method is called automatically. The startApp() method is left for the invoker to call if appropriate. Invoking this method amounts to creating an instance of JXTA. Since JXTA stores its persistent state in the local filesystem relative to the initial current directory, it is unadvisable to start more than one instance with the same current directory.
Returns:
PeerGroup instance of a new Platform
Since:
JXTA 1.0

newNetPeerGroup

public static PeerGroup newNetPeerGroup(PeerGroup pg)
                                 throws PeerGroupException
Until the concept of netPeerGroup is better integrated, we need something straightforward so that applications that whish to control the start-up process can easily bring up a netPeerGroup like startNetPeerGroup does. This method does this.
Parameters:
pg - The platform group.
pgId - The group ID to be assigned. If null, then the default netPeerGroup is created, with its well known ID, otherwise, the given one is used. Valid values include "" which causes the platform to pick an ID itself.
sig - A signature that gets included in the group's advertisement. If a null gid is provided, then this parameter is ignored and the signature is always "default".

Project JXTA