Project JXTA

Uses of Interface
net.jxta.peergroup.PeerGroup

Packages that use PeerGroup
net.jxta.credential Credentials provide the basic mechanisms for securly establishing and communicating identity within JXTA. 
net.jxta.endpoint Provides interfaces and classes used for the addressing, filtering, sending, and receiving of messages within JXTA. 
net.jxta.peergroup Peer groups are formed as a collection of peers that have agreed upon a common set of services.  
net.jxta.platform Classes for defining code modules within JXTA.  
net.jxta.socket The socket package provides interface ala Socket over JXTA pipes.  
net.jxta.util A collection of utility classes used by the JXTA implementation and/or useful to users of the JXTA API. 
 

Uses of PeerGroup in net.jxta.credential
 

Constructors in net.jxta.credential with parameters of type PeerGroup
AuthenticationCredential(PeerGroup peergroup, String method, Element indentityInfo)
          Creates new AuthenticationCredential
AuthenticationCredential(PeerGroup peergroup, Element root)
          Creates new AuthenticationCredential
 

Uses of PeerGroup in net.jxta.endpoint
 

Methods in net.jxta.endpoint that return PeerGroup
 PeerGroup EndpointService.getGroup()
          Returns the group to which this EndpointService is attached.
 

Uses of PeerGroup in net.jxta.peergroup
 

Classes in net.jxta.peergroup that implement PeerGroup
 class LightWeightPeerGroup
          LightWeightPeerGroup is a class intended to help building PeerGroup that can inherit one or more services from a parent PeerGroup.
 

Methods in net.jxta.peergroup that return PeerGroup
static PeerGroup PeerGroupFactory.newPeerGroup()
          Static Method to create a new peer group instance.
static PeerGroup PeerGroupFactory.newPlatform()
          Instantiates the Platform Peer Group.
static PeerGroup PeerGroupFactory.newNetPeerGroup(PeerGroup ppg)
          Instantiates the net peer group using the provided platform peer group.
static PeerGroup PeerGroupFactory.newNetPeerGroup()
          Instantiates the platform peergroup and then instantiates the net peer group.
 PeerGroup PeerGroup.newGroup(Advertisement pgAdv)
          Instantiate a peer group from its given advertisement.
 PeerGroup PeerGroup.newGroup(PeerGroupID gid, Advertisement impl, String name, String description)
          Instantiates a new group from its elementary pieces and publishes the corresponding PeerGroupAdvertisement.
 PeerGroup PeerGroup.newGroup(PeerGroupID gid)
          Instantiate a group from its Peer Group ID only.
 PeerGroup PeerGroup.getWeakInterface()
          Returns a weak interface object that represents this group.
 PeerGroup PeerGroup.getParentGroup()
          Returns the parent group of this group.
 PeerGroup PeerGroup.GlobalRegistry.lookupInstance(PeerGroupID gid)
          Returns a running instance of the peergroup with given ID if any exists.
 PeerGroup LightWeightPeerGroup.getParentGroup()
          Returns the parent group of this group. Not all groups have parents and some implementations may not reveal their parents.
 PeerGroup LightWeightPeerGroup.newGroup(Advertisement pgAdv)
          Instantiate a peer group from its given advertisement. This instantiator requires that the ModuleImplAdvertisment for the peer group and the ModuleImplAdvertisements for the group's services be available for discovery within the current group.

The pgAdv itself may be all new and unpublished. Therefore, the two typical uses of this routine are:

  • Creating an all new group with a new ID while using an existing and published implementation. (Possibly a new one published for that purpose). The information should first be gathered in a new PeerGroupAdvertisement which is then passed to this method.
  • Instantiating a group which advertisement has already been discovered (therefore there is no need to find it by groupID again).

To create a group from a known implAdv, use newGroup(PeerGroupID,Advertisement,String,String)

 PeerGroup LightWeightPeerGroup.newGroup(PeerGroupID gid, Advertisement impl, String name, String description)
          Instantiates a new group from its elementary pieces and publishes the corresponding PeerGroupAdvertisement. The pieces are: the groups implementation adv, the group id, the name and description.

The typical use of this routine is creating a whole new group based on a newly created and possibly unpublished implementation adv.

This is a convenience method equivalent to either:

 newGrp = thisGroup.loadModule(gid, impl);
 newGrp.publishGroup(name, description);
 

or, but only if the implementation advertisement has been published:

 newPGAdv = AdvertisementFactory.newAdvertisement(
                 PeerGroupAdvertisement.getAdvertisementType());
 newPGAdv.setPeerGroupID(gid);
 newPGAdv.setModuleSpecID(impl.getModuleSpecID());
 newPGAdv.setName(name);
 newPGAdv.setDescription(description);
 newGrp = thisGroup.newGroup(newPGAdv);
 
 PeerGroup LightWeightPeerGroup.newGroup(PeerGroupID gid)
          Instantiate a group from its Peer Group ID only. Use this when using a group that has already been published and discovered.

The typical uses of this routine are therefore:

  • Instantiating a peer group which is assumed to exist and whose Peer Group ID is already known.
  • Creating a new peer group instance using an already published Group advertisement, typically published for that purpose. All other referenced advertisements must also be available.

To create a group from a known implAdv, just use loadModule(ID,Advertisement) or even:

grp = new GroupSubClass(); grp.init(parentGroup, gid, impladv);

then, REMEMBER TO PUBLISH THE GROUP IF IT IS ALL NEW.

 PeerGroup LightWeightPeerGroup.getWeakInterface()
          Returns a weak interface object that represents this group.

A weak interface object has no life-cycle privileges over the group that it represents and therefore its users have no accountability. A weak interface object is safe to give away but holds no promise of sustained validity.

Whatever code gave away a weak interface object retains the power of terminating the group object from which it was obtained, thereby making the weak interface object invalid.

A weak interface object is immutable; its unref and stopApp methods do nothing. Its validity is exactly that of the group or interface object from which it was obtained.

A weak interface object can be obtained from an interface object, or from a real group object, or from a weak interface object. In the later case, the object returned may be the original weak interface object since such objects are immutable.

Whatever code obtains a weak interface object from a group object or regular interface object, remains entirely liable for invoking unref on the initial object before discarding it. Giving away a weak interface object is not equivalent to transfering ownerhsip of the original.

 

Methods in net.jxta.peergroup with parameters of type PeerGroup
static PeerGroup PeerGroupFactory.newNetPeerGroup(PeerGroup ppg)
          Instantiates the net peer group using the provided platform peer group.
 boolean PeerGroup.GlobalRegistry.registerInstance(PeerGroupID gid, PeerGroup pg)
          Registers a new instance.
 boolean PeerGroup.GlobalRegistry.unRegisterInstance(PeerGroupID gid, PeerGroup pg)
          Unregisters a group instance (normaly because the group is being stopped.
 void LightWeightPeerGroup.init(PeerGroup group, ID assignedID, Advertisement implAdv)
          Initialize the module, passing it its peer group and advertisement.

Note: when subclassing one of the existing PeerGroup implementations (which implement Module), it may not be recommended to overload the init method. See the documentation of the PeerGroup class being subclassed.

 

Uses of PeerGroup in net.jxta.platform
 

Methods in net.jxta.platform with parameters of type PeerGroup
 void Module.init(PeerGroup group, ID assignedID, Advertisement implAdv)
          Initialize the module, passing it its peer group and advertisement.
 

Uses of PeerGroup in net.jxta.socket
 

Fields in net.jxta.socket declared as PeerGroup
protected  PeerGroup JxtaSocket.group
           
protected  PeerGroup JxtaServerSocket.group
           
protected  PeerGroup JxtaMulticastSocket.group
           
 

Methods in net.jxta.socket that return PeerGroup
 PeerGroup JxtaServerSocket.getGroup()
          Gets the group associated with this JxtaServerSocket object
 

Methods in net.jxta.socket with parameters of type PeerGroup
 void JxtaSocket.connect(PeerGroup group, PipeAdvertisement pipeAd)
          Connects to a remote JxtaSocket on any peer within the default timeout of 60 seconds
 void JxtaSocket.connect(PeerGroup group, PipeAdvertisement pipeAd, int timeout)
          Connects to a remote JxtaSocket on any peer within a timeout specified in milliseconds
 void JxtaSocket.connect(PeerGroup group, PeerID peerid, PipeAdvertisement pipeAd, int timeout)
          Connects to a remote JxtaSocket on a specific peer within a timeout specified in milliseconds
protected static StructuredDocument JxtaSocket.getCredDoc(PeerGroup group)
          obtain the cred doc from the group object
protected  Message JxtaSocket.createOpenMessage(PeerGroup group, PipeAdvertisement pipeAd)
          Create a connection request message
protected static Messenger JxtaSocket.lightweightOutputPipe(PeerGroup group, PipeAdvertisement pipeAdv, PeerAdvertisement peer)
          A lightweight output pipe constructor, note the return type Since all the info needed is available, there's no need for to use the pipe service to resolve the pipe we have all we need to construct a messenger.
 void JxtaServerSocket.bind(PeerGroup group, PipeAdvertisement pipeadv)
          Binds the JxtaServerSocket to a specific pipe advertisement
 void JxtaServerSocket.bind(PeerGroup group, PipeAdvertisement pipeadv, int backlog)
          Binds the JxtaServerSocket to a specific pipe advertisement
protected  void JxtaServerSocket.sendResponseMessage(PeerGroup group, Messenger msgr, PipeAdvertisement pipeAd)
          Method sendResponseMessage get the createResponseMessage and sends it.
protected static PipeAdvertisement JxtaServerSocket.newInputPipe(PeerGroup group, PipeAdvertisement pipeadv)
          Utility method newInputPipe is used to get new pipe advertisement (w/random pipe ID) from old one.
 void JxtaMulticastSocket.joinGroup(PeerGroup group, PipeAdvertisement pipeAd)
          joins MutlicastSocket to specified pipe within the context of group
protected static StructuredDocument JxtaMulticastSocket.getCredDoc(PeerGroup group)
          Obtain the credential doc from the group object
 

Constructors in net.jxta.socket with parameters of type PeerGroup
JxtaSocket(PeerGroup group, Messenger msgr, PipeAdvertisement pipe, StructuredDocument credDoc, boolean isStream)
          Constructor for the JxtaSocket, this constructor does not establish a connection use this constructor when altering the default parameters, and options of the socket by default connections are unreliable, and the default timeout is 60 seconds to alter a connection a call to create(true) changes the connection to a reliable one.
JxtaSocket(PeerGroup group, PipeAdvertisement pipeAd)
          Create a JxtaSocket to any peer listening on pipeAdv
JxtaSocket(PeerGroup group, PipeAdvertisement pipeAd, int timeout)
          Create a JxtaSocket to any peer listening on pipeAdv this attempts establish a connection to specified pipe within the context of the specified group within timeout specified in milliseconds
JxtaSocket(PeerGroup group, PeerID peerid, PipeAdvertisement pipeAd, int timeout)
          Create a JxtaSocket to any peer listening on pipeAdv this attempts establish a connection to specified pipe within a context of group and within timeout specified in milliseconds
JxtaSocket(PeerGroup group, PeerID peerid, PipeAdvertisement pipeAd, int timeout, boolean stream)
          Create a JxtaSocket to any peer listening on pipeAdv this attempts establish a connection to specified pipe within a context of group and within timeout specified in milliseconds
JxtaServerSocket(PeerGroup group, PipeAdvertisement pipeadv)
          Constructor for the JxtaServerSocket The backlog defaults to 50.
JxtaServerSocket(PeerGroup group, PipeAdvertisement pipeadv, int backlog)
          Constructor for the JxtaServerSocket object
JxtaServerSocket(PeerGroup group, PipeAdvertisement pipeadv, int backlog, int timeout)
          Constructor for the JxtaServerSocket object The timeout defaults to 0, i.e. blocking.
JxtaMulticastSocket(PeerGroup group, PipeAdvertisement pipeAd)
          Create a multicast socket and bind it to a specific pipe within specified peer group
 

Uses of PeerGroup in net.jxta.util
 

Fields in net.jxta.util declared as PeerGroup
protected  PeerGroup JxtaBiDiPipe.group
           
 

Methods in net.jxta.util that return PeerGroup
 PeerGroup JxtaServerPipe.getGroup()
          Gets the group associated with this JxtaServerPipe
 

Methods in net.jxta.util with parameters of type PeerGroup
static PipeAdvertisement PipeUtilities.createNewPipeAdvertisement(PeerGroup peerGroup, String pipeType)
           
 void JxtaServerPipe.bind(PeerGroup group, PipeAdvertisement pipeadv)
          Binds the JxtaServerPipe to a specific pipe advertisement
 void JxtaServerPipe.bind(PeerGroup group, PipeAdvertisement pipeadv, int backlog)
          Binds the JxtaServerPipe to a specific pipe advertisement
protected  void JxtaServerPipe.sendResponseMessage(PeerGroup group, Messenger msgr, PipeAdvertisement pipeAd)
          Method sendResponseMessage get the createResponseMessage and sends it.
protected static PipeAdvertisement JxtaServerPipe.newInputPipe(PeerGroup group, PipeAdvertisement pipeadv)
          Utility method newInputPipe is used to get new pipe advertisement (w/random pipe ID) from old one.
 void JxtaBiDiPipe.connect(PeerGroup group, PipeAdvertisement pipeAd)
          Connect to JxtaBiDiPipe with default timeout
 void JxtaBiDiPipe.connect(PeerGroup group, PipeAdvertisement pipeAd, int timeout)
          Connects to a remote JxtaBiDiPipe
 void JxtaBiDiPipe.connect(PeerGroup group, PeerID peerid, PipeAdvertisement pipeAd, int timeout, PipeMsgListener listener)
          Connects to a remote JxtaBiDiPipe
 void JxtaBiDiPipe.connect(PeerGroup group, PeerID peerid, PipeAdvertisement pipeAd, int timeout, PipeMsgListener listener, boolean reliable)
          Connects to a remote JxtaBiDiPipe
protected static StructuredDocument JxtaBiDiPipe.getCredDoc(PeerGroup group)
          obtain the cred doc from the group object
protected  Message JxtaBiDiPipe.createOpenMessage(PeerGroup group, PipeAdvertisement pipeAd)
          Create a connection request message
protected static Messenger JxtaBiDiPipe.lightweightOutputPipe(PeerGroup group, PipeAdvertisement pipeAdv, PeerAdvertisement peer)
          A lightweight output pipe constructor, note the return type Since all the info needed is available, there's no need for to use the pipe service to resolve the pipe we have all we need to construct a messenger.
static Advertisement DiscoveryUtilities.getLocalAdvertisement(PeerGroup peerGroup, String name, String value)
          Deprecated. Just use discovery directly. This method doesn't seem to do anything useful.
static PipeAdvertisement AdvertisementUtilities.createPipeAdvertisement(PeerGroup peerGroup, String pipeType)
          Deprecated. Create a Pipe Advertisement
static PipeAdvertisement AdvertisementUtilities.createPipeAdvertisement(PeerGroup peerGroup, String sPipeID, String pipeType, String name)
          Deprecated. Create a Pipe Advertisement
static void AdvertisementUtilities.cachePeerAdvertisement(PeerGroup peerGroup, PeerAdvertisement peerAdvertisement)
          Deprecated. Publish and advertisement to the Cache
 

Constructors in net.jxta.util with parameters of type PeerGroup
JxtaServerPipe(PeerGroup group, PipeAdvertisement pipeadv)
          Default constructor for the JxtaServerPipe backlog default of 50 timeout defaults to 60 seconds, i.e. blocking.
JxtaServerPipe(PeerGroup group, PipeAdvertisement pipeadv, int backlog, int timeout)
          Constructor for the JxtaServerPipe
JxtaServerPipe(PeerGroup group, PipeAdvertisement pipeadv, int backlog)
          Constructor for the JxtaServerPipe object
JxtaBiDiPipe(PeerGroup group, Messenger msgr, PipeAdvertisement pipe, StructuredDocument credDoc, boolean isReliable)
          JxtaBiDiPipe A bidirectional pipe
JxtaBiDiPipe(PeerGroup group, PipeAdvertisement pipeAd, PipeMsgListener listener)
          attempts to create a bidirectional connection to remote peer within default timeout of 60,000ms, and initiates a connection
JxtaBiDiPipe(PeerGroup group, PipeAdvertisement pipeAd, int timeout, PipeMsgListener listener)
          attempts to create a bidirectional connection to remote peer within default timeout of 1 minutes, and initiates a connection
JxtaBiDiPipe(PeerGroup group, PipeAdvertisement pipeAd, int timeout, PipeMsgListener listener, boolean reliable)
          attempts to create a bidirectional connection to remote peer within default timeout of 60,000ms, and initiates a connection
 


JXTA J2SE