Project JXTA

Uses of Class
net.jxta.id.ID

Packages that use ID
net.jxta.codat Codats are container objects that can hold both data or code and are associated with a JXTA ID. 
net.jxta.credential Credentials provide the basic mechanisms for securly establishing and communicating identity within JXTA. 
net.jxta.discovery The JXTA Discovery Service provides an asynchronous mechanism for discovering Peer Advertisements, Group Advertisements, and other general JXTA Advertisements (pipes, services, etc.). 
net.jxta.document JXTA Documents are containers for both structured and unstructured data.  
net.jxta.endpoint Provides interfaces and classes used for the addressing, filtering, sending, and receiving of messages within JXTA. 
net.jxta.id IDs are used within JXTA to refer to peers, peer groups, pipes and other types of resources. 
net.jxta.peer Provides definition for the Peer ID standard JXTA Peer Info Service.  
net.jxta.peergroup Peer groups are formed as a collection of peers that have agreed upon a common set of services.  
net.jxta.pipe Pipes are the core mechanism for exchanging messages between JXTA applications or services. 
net.jxta.platform Classes for defining code modules within JXTA.  
net.jxta.protocol Provides inteface objects for Advertisments and protocol messages for the JXTA Core and Standard Protocols. 
net.jxta.rendezvous The RendezVous Service is responsible for propagating messages within a JXTA PeerGroup. 
net.jxta.util A collection of utility classes used by the JXTA implementation and/or useful to users of the JXTA API. 
 

Uses of ID in net.jxta.codat
 

Subclasses of ID in net.jxta.codat
 class CodatID
          Codats are JXTA objects that can hold both data or code.
 

Fields in net.jxta.codat declared as ID
protected  ID Codat.id
          Id of this Codat.
protected  ID Codat.metaId
          Codat Id of a Codat to which this Codat is related.
 

Methods in net.jxta.codat that return ID
abstract  ID CodatID.getPeerGroupID()
          Returns PeerGroupID of the Peer Group to which this Codat ID belongs.
 ID Codat.getCodatID()
          Returns the CodatId associated with this Codat.
 ID Codat.getMetaID()
          Returns Codat id of related codat associated with this metadata Codat.
 

Constructors in net.jxta.codat with parameters of type ID
Codat(PeerGroupID groupID, ID about, Document document)
          Makes a new Codat with a new CodatId given a PeerGroupID and a document.
 

Uses of ID in net.jxta.credential
 

Methods in net.jxta.credential that return ID
 ID Credential.getPeerGroupID()
          Returns the peerGroupID associated with this credential
 ID Credential.getPeerID()
          Returns the peerID associated with this credential
 ID AuthenticationCredential.getPeerGroupID()
          Returns the peerGroupID associated with this credential

AuthenticationCredentials are created in the context of a PeerGroup though they are generally independant of peergroups.

 ID AuthenticationCredential.getPeerID()
          Returns the peerID associated with this credential
 

Uses of ID in net.jxta.discovery
 

Methods in net.jxta.discovery with parameters of type ID
 long DiscoveryService.getAdvExpirationTime(ID id, int type)
          Returns the maximum duration in milliseconds for which this document should be cached by those other than the publisher.
 long DiscoveryService.getAdvLifeTime(ID id, int type)
          Returns the maximum duration in milliseconds for which this document should be kept in local cache
 

Uses of ID in net.jxta.document
 

Methods in net.jxta.document that return ID
abstract  ID Advertisement.getID()
          Returns a unique ID suitable for indexing of this Advertisement.
 

Uses of ID in net.jxta.endpoint
 

Constructors in net.jxta.endpoint with parameters of type ID
EndpointAddress(ID id, String service, String serviceParam)
          Constructor which builds an address from a standard jxta id and a service and param.
 

Uses of ID in net.jxta.id
 

Fields in net.jxta.id declared as ID
static ID ID.nullID
          The null ID.
 

Methods in net.jxta.id that return ID
static ID IDFactory.fromURI(URI source)
          Construct a new ID instance from a JXTA ID contained in a URI.
static ID IDFactory.fromURL(URL source)
          Deprecated. Use of URLs for representing JXTA IDs and this method are deprecated. Convert to using IDFactory.fromURI( URI ) instead.
 ID IDFactory.Instantiator.fromURL(URL source)
          Deprecated. Convert to fromURI.
 ID IDFactory.URIInstantiator.fromURI(URI source)
          Construct a new ID instance from a JXTA ID contained in a URI.
 ID IDFactory.URIInstantiator.fromURNNamespaceSpecificPart(String source)
          Construct a new ID instance from the scheme specific portion of a jxta URN.
static ID ID.create(URI fromURI)
          Creates an ID by parsing the given URI.
 

Uses of ID in net.jxta.peer
 

Subclasses of ID in net.jxta.peer
 class PeerID
          This class implements a PeerID.
 

Methods in net.jxta.peer that return ID
abstract  ID PeerID.getPeerGroupID()
          Returns PeerGroupID of the Peer Group to which this Peer ID belongs.
 

Uses of ID in net.jxta.peergroup
 

Subclasses of ID in net.jxta.peergroup
 class PeerGroupID
          This class implements a PeerGroup ID.
 

Methods in net.jxta.peergroup with parameters of type ID
 Service PeerGroup.lookupService(ID name)
          Lookup for a service by name.
 Service PeerGroup.lookupService(ID name, int roleIndex)
          Lookup for a service by class ID and index in a map.
 Iterator PeerGroup.getRoleMap(ID name)
          Returns the map of the assigned IDs currently associated with the given ModuleClassID by this PeerGroup object.
 Module PeerGroup.loadModule(ID assignedID, Advertisement impl)
          Load a module from a ModuleImplAdv.
 Module PeerGroup.loadModule(ID assignedID, ModuleSpecID specID, int where)
          Load a module from a spec id.
 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.

 Service LightWeightPeerGroup.lookupService(ID name)
          Lookup for a service by name.
 Service LightWeightPeerGroup.lookupService(ID name, int ignoredForNow)
          Lookup for a service by class ID and index in a map. More than one service in a group may be of a given ModuleClass. However each of them has a unique assigned ID which serves as the index in the map of services. In most cases, there is only one service of each given Module Class, and the ID of that Module Class is the assigned ID. Otherwise, the group may have a list of existing assigned ID per base class. This routine may be used to retrieve services of the given Module Class and index in that list. In the absence of a mapping, index 0 is still valid and corresponds to the service which assigned ID is exactly the given ID. Group objects with a map are normaly wrappers taylored specially by the loader of a module (often the group itself) in order to provide a map appropriate for that module. Modules that do not use more than one service of a given base class normally never need to call this method; lookupService(ID) is equivalent to lookupService(ID, 0) and will transparently remap index 0 to whatever the group's structure defines as the default for the invoking service. Note: traditionaly, the given ID is expected to be a base Module Class ID, and the assigned ID of a Module is a Class ID of the same base class with a role suffix to make it unique. If the given ID already contains a role suffix, there may exist an entry for it in the map anyway, if not (which is the expected use pattern), then only index 0 exists and the given ID is used whole and untranslated.
 Iterator LightWeightPeerGroup.getRoleMap(ID name)
          Returns the map of the assigned IDs currently associated with the given ModuleClassID by this PeerGroup object. The IDs are returned in the order of their index in the map. So the first ID returned will be identical to what would be returned by the lookup method for the given ID and index 0. If there is no explicit such map, this method will return a singleton containing the given ID as this is the default mapping. There is no guarantee that any of the returned IDs correspond to an actually registered service. This method only maps IDs.
 Module LightWeightPeerGroup.loadModule(ID assignedID, Advertisement impl)
          Load a module from a ModuleImplAdv. Compatibility is checked and load is attempted. If compatible and loaded successfuly, the resulting Module is initialized and returned. In most cases the other loadModule() method should be preferred, since unlike this one, it will seek many compatible implementation advertisements and try them all until one works. The home group of the new module (its parent group if the new module is a group) will be this group.
 Module LightWeightPeerGroup.loadModule(ID assignedID, ModuleSpecID specID, int where)
          Load a module from a spec id. Advertisement is sought, compatibility is checked on all candidates and load is attempted. The first one that is compatible and loads successfuly is initialized and returned.
 

Uses of ID in net.jxta.pipe
 

Subclasses of ID in net.jxta.pipe
 class PipeID
          This class implements a Pipe ID.
 

Methods in net.jxta.pipe that return ID
abstract  ID PipeID.getPeerGroupID()
          Returns PeerGroupID of the Peer Group to which this Peer ID belongs.
 ID OutputPipe.getPipeID()
          Gets the pipe id
 ID InputPipe.getPipeID()
          Gets the pipe id
 

Uses of ID in net.jxta.platform
 

Subclasses of ID in net.jxta.platform
 class ModuleClassID
          A ModuleClassID uniquely identifies a particular local behaviour, that is, a specific API for each execution environment for which an implementation exists.
 class ModuleSpecID
          A ModuleSpecID uniquely identifies a particular network behaviour (wire protocol and choregraphy) that may be embodied by a Jxta Module.
 

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

Uses of ID in net.jxta.protocol
 

Methods in net.jxta.protocol that return ID
 ID TransportAdvertisement.getID()
          Return ID for indexing.
 ID RouteAdvertisement.getID()
          Returns a unique ID suitable for indexing of this Advertisement.

The ID is supposed to be unique and is not guaranteed to be of any particular subclass of ID. Each class of advertisement is responsible for the choice of ID to return. The value for the ID returned can either be:

  • An ID which is already part of the advertisement definition and is relatively unique between advertisements instances. For example, the Peer Advertisement returns the Peer ID.
  • A static CodatID which is generated via some canonical process which will produce the same value each time and different values for different advertisements of the same type.
  • ID.nullID for advertisement types which are not readily indexed.

Since this ID is normally used for indexing, the IDs returned must be as unique as possible to avoid collisions.

For Advertisement types which normally return non-ID.nullID values no ID should be returned when asked to generate an ID while the Advertisement is an inconsistent state (example: unitialized index fields). Instead java.lang.IllegalStateException should be thrown.

 ID RdvAdvertisement.getID()
          Returns a unique ID suitable for indexing of this Advertisement.

The ID is supposed to be unique and is not guaranteed to be of any particular subclass of ID. Each class of advertisement is responsible for the choice of ID to return. The value for the ID returned can either be:

  • An ID which is already part of the advertisement definition and is relatively unique between advertisements instances. For example, the Peer Advertisement returns the Peer ID.
  • A static CodatID which is generated via some canonical process which will produce the same value each time and different values for different advertisements of the same type.
  • ID.nullID for advertisement types which are not readily indexed.

Since this ID is normally used for indexing, the IDs returned must be as unique as possible to avoid collisions.

For Advertisement types which normally return non-ID.nullID values no ID should be returned when asked to generate an ID while the Advertisement is an inconsistent state (example: unitialized index fields). Instead java.lang.IllegalStateException should be thrown.

 ID PipeResolverMessage.getPipeID()
          Return the id of the pipe which is the subject of this message.
 ID PipeAdvertisement.getID()
          get an ID for indexing purposes.
 ID PipeAdvertisement.getPipeID()
          get the pipe id
 ID PeerGroupAdvertisement.getID()
          Returns a unique ID for indexing purposes.
 ID PeerAdvertisement.getID()
          Returns a unique ID for that peer X group intersection.
 ID ModuleSpecAdvertisement.getID()
          returns a unique id for that adv for the purpose of indexing.
 ID ModuleImplAdvertisement.getID()
          Returns the unique ID of that advertisement for indexing purposes.
 ID ModuleClassAdvertisement.getID()
          returns a unique ID for that advertisement (for indexing purposes).
 

Methods in net.jxta.protocol with parameters of type ID
 void PipeResolverMessage.setPipeID(ID id)
          Set the id of pipe which is to be subject of this message.
 void PipeResolverMessage.addPeerID(ID id)
          Add a peer to the set of peers to which this query is directed.
 void PipeAdvertisement.setPipeID(ID pipeId)
          set the pipe Id
 void PeerGroupAdvertisement.putServiceParam(ID key, Element param)
          Puts a service parameter in the service parameters table under the given key.
 StructuredDocument PeerGroupAdvertisement.getServiceParam(ID key)
          Returns the parameter element that matches the given key from the service parameters table.
 StructuredDocument PeerGroupAdvertisement.removeServiceParam(ID key)
          Removes and returns the parameter element that matches the given key from the service parameters table.
 void PeerAdvertisement.putServiceParam(ID key, Element param)
          Puts a service parameter in the service parameters table under the given key.
 StructuredDocument PeerAdvertisement.getServiceParam(ID key)
          Returns the parameter element that matches the given key from the service parameters table.
 StructuredDocument PeerAdvertisement.removeServiceParam(ID key)
          Removes and returns the parameter element that matches the given key from the service parameters table.
 void ConfigParams.putServiceParam(ID key, Element param)
          Puts a service parameter in the service parameters table under the given key.
 StructuredDocument ConfigParams.getServiceParam(ID key)
          Returns the parameter element that matches the given key from the service parameters table.
 StructuredDocument ConfigParams.removeServiceParam(ID key)
          Removes and returns the parameter element that matches the given key from the service parameters table.
 

Uses of ID in net.jxta.rendezvous
 

Methods in net.jxta.rendezvous that return ID
 ID RendezvousEvent.getPeerID()
          Returns peerid
 

Methods in net.jxta.rendezvous with parameters of type ID
 void RendezVousService.disconnectFromRendezVous(ID peerID)
          Disconnect from the specified rendezvous
 void RendezVousService.challengeRendezVous(ID peer, long timeout)
          Set a new deadline for the rendezvous to be proven alive.
 

Constructors in net.jxta.rendezvous with parameters of type ID
RendezvousEvent(Object source, int type, ID peer)
          Creates a new event
 

Uses of ID in net.jxta.util
 

Methods in net.jxta.util with parameters of type ID
static PipeAdvertisement AdvertisementUtilities.createPipeAdvertisement(ID pipeID, String pipeType)
          Deprecated. Create a Pipe Advertisement
 


JXTA J2SE