Project JXTA

Uses of Class
net.jxta.document.Advertisement

Packages that use Advertisement
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.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.protocol Provides inteface objects for Advertisments and protocol messages for the JXTA Core and Standard Protocols. 
net.jxta.service Every service is defined by a ModuleImplAdvertisement.  
net.jxta.util A collection of utility classes used by the JXTA implementation and/or useful to users of the JXTA API. 
 

Uses of Advertisement in net.jxta.discovery
 

Methods in net.jxta.discovery with parameters of type Advertisement
 void DiscoveryService.publish(Advertisement advertisement)
          Publish an advertisement with a default lifetime of DEFAULT_LIFETIME and default expiration time for "others" of DEFAULT_EXPIRATION Advertisement indexes are shared with a rendezvous peer upon connect, and subsequent publications are shared at a an implementation specified interval
 void DiscoveryService.publish(Advertisement advertisement, int type)
          Deprecated. Advertisement type is no longer required to publish an advertisement
 void DiscoveryService.publish(Advertisement adv, long lifetime, long lifetimeForOthers)
          Publish an advertisement that will expire after a certain time.
 void DiscoveryService.publish(Advertisement adv, int type, long lifetime, long lifetimeForOthers)
          Deprecated. Advertisement type is no longer required to publish an advertisement
 void DiscoveryService.remotePublish(Advertisement adv, int type)
          Deprecated. Advertisement type is no longer required to remote publish an advertisement
 void DiscoveryService.remotePublish(Advertisement adv)
          Remote Publish an advertisement will attempt to remote publish adv on all configured transports, the Advertisement will carry a lifetime of Expiration time, or lifetime whichever is smaller
 void DiscoveryService.remotePublish(Advertisement adv, int type, long lifetime)
          Deprecated. Advertisement type is no longer required to remote publish an advertisement
 void DiscoveryService.remotePublish(Advertisement adv, long lifetime)
          Remote Publish an advertisement will attempt to remote publish adv on all configured transports, the Advertisement will carry a a expiration of lifetime
 void DiscoveryService.remotePublish(String peerid, Advertisement adv, int type)
          Deprecated. Advertisement type is no longer required to remote publish an advertisement
 void DiscoveryService.remotePublish(String peerid, Advertisement adv)
          Remote Publish an advertisement will attempt to remote publish adv on all configured transports, the Advertisement will carry a lifetime of Expiration time, or lifetime whichever is smaller
 void DiscoveryService.remotePublish(String peerid, Advertisement adv, int type, long lifetime)
          Deprecated. Advertisement type is no longer required to remote publish an advertisement
 void DiscoveryService.remotePublish(String peerid, Advertisement adv, long lifetime)
          Remote Publish an advertisement will attempt to remote publish adv on all configured transports, the Advertisement will carry a a expiration of lifetime
 void DiscoveryService.flushAdvertisement(Advertisement adv)
          flush a stored Advertisement
 long DiscoveryService.getAdvExpirationTime(Advertisement adv)
          Returns the maximum duration in milliseconds for which this document should be cached by those other than the publisher.
 long DiscoveryService.getAdvLifeTime(Advertisement adv)
          Returns the maximum duration in milliseconds for which this document should be kept in local cache
 

Uses of Advertisement in net.jxta.document
 

Subclasses of Advertisement in net.jxta.document
 class ExtendableAdvertisement
          Extendable advertisements provide features for allowing inheritance of advertisement types.
 

Methods in net.jxta.document that return Advertisement
static Advertisement AdvertisementFactory.newAdvertisement(String advertisementType)
          Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.
static Advertisement AdvertisementFactory.newAdvertisement(MimeMediaType mimetype, InputStream stream)
          Constructs an instance of Advertisement from the provided InputStream.
static Advertisement AdvertisementFactory.newAdvertisement(MimeMediaType mimetype, Reader source)
          Constructs an instance of Advertisement from the provided Reader.
static Advertisement AdvertisementFactory.newAdvertisement(TextElement root)
          Constructs an instance of Advertisement matching the type specified by the root parameter.
 Advertisement AdvertisementFactory.Instantiator.newInstance()
          Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.
 Advertisement AdvertisementFactory.Instantiator.newInstance(Element root)
          Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.
 

Uses of Advertisement in net.jxta.peergroup
 

Methods in net.jxta.peergroup that return Advertisement
 Advertisement LightWeightPeerGroup.getImplAdvertisement()
          Returns the advertisment for this service.
 

Methods in net.jxta.peergroup with parameters of type Advertisement
 Module PeerGroup.loadModule(ID assignedID, Advertisement impl)
          Load a module from a ModuleImplAdv.
 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.
 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.

 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.
 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 PeerGroup.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);
 
 

Uses of Advertisement in net.jxta.platform
 

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

Uses of Advertisement in net.jxta.protocol
 

Subclasses of Advertisement in net.jxta.protocol
 class AccessPointAdvertisement
          A short representation of the physical endpoint addresses available for a specific peer.
 class ConfigParams
          A container for configuration parameters.
 class ModuleClassAdvertisement
          A ModuleClassAdvertisement describes a module class.
 class ModuleImplAdvertisement
          A ModuleImplAdvertisement represents one of any number of published implementations of a given specification.
 class ModuleSpecAdvertisement
          A ModuleSpecAdvertisement describes a module specification.
 class PeerAdvertisement
          This type of advertisement is generated when instantiating a group on a peer and contains all the parameters that services need to publish.
 class PeerGroupAdvertisement
          Describes a peer group and references additional information required for instantiating it.
 class PipeAdvertisement
          This class defines the PipeServiceImpl Advertisement.
 class RdvAdvertisement
          This class defines a Rendezvous Advertisement
 class RouteAdvertisement
          This type of advertisement is used to represent a route to a destination peer in the JXTA virtual network.
 class SignedAdvertisement
          A container for signed Advertisements
 class TransportAdvertisement
          This abstract class defines a Transport advertisement.
 

Fields in net.jxta.protocol declared as Advertisement
protected  Advertisement SignedAdvertisement.adv
           
 

Methods in net.jxta.protocol that return Advertisement
 Advertisement SignedAdvertisement.getAdvertisement()
          Gets the Advertisement.
 

Methods in net.jxta.protocol with parameters of type Advertisement
 void SignedAdvertisement.setAdvertisement(Advertisement adv)
          Sets the Advertisement to be signed.
 

Uses of Advertisement in net.jxta.service
 

Methods in net.jxta.service that return Advertisement
 Advertisement Service.getImplAdvertisement()
          Returns the advertisment for this service.
 

Uses of Advertisement in net.jxta.util
 

Methods in net.jxta.util that return Advertisement
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 Advertisement AdvertisementUtilities.readAdvertisementFromFile(String fileName)
          Deprecated. Read a JXTA Advertisement from a File
static Advertisement AdvertisementUtilities.readAdvertisementFromFile(File file)
          Deprecated. Read a JXTA Advertisement from a File
static Advertisement AdvertisementUtilities.bytesToAdvertisement(byte[] buf)
          Deprecated. This method should not be used because it interprets the input using the local default encoding which is not precidcatable and may (will) differ from JVM to JVM.
static Advertisement AdvertisementUtilities.newAdvertisementFromXml(byte[] xmlTextAsBytes)
          Deprecated. This method should not be used because it produces a result who's encoding is not predictable and may (will) differ from JVM to JVM.
static Advertisement AdvertisementUtilities.newAdvertisementFromXml(String xmlText)
          Deprecated. This method should not be used because it interprets the input using the local default encoding which is not precidcatable and may (will) differ from JVM to JVM.
 

Methods in net.jxta.util with parameters of type Advertisement
static void AdvertisementUtilities.saveAdvertisementToFile(Advertisement adv, String fileName)
          Deprecated. Save a JXTA Advertisement as an XML Document to a File
static void AdvertisementUtilities.saveAdvertisementToFile(Advertisement adv, File file)
          Deprecated. Save a JXTA Advertisement as an XML Document to a File
static byte[] AdvertisementUtilities.advertisementToBytes(Advertisement advertisement)
          Deprecated. This method should not be used because it produces a result who's encoding is not predictable and may (will) differ from JVM to JVM.
static String AdvertisementUtilities.advertisementToText(Advertisement advertisement, String mimeType)
          Deprecated. Save a JXTA Advertisement to a String
static String AdvertisementUtilities.advertisementToPlainText(Advertisement advertisement)
          Deprecated. Save a JXTA Advertisement to a Plain Text String
static String AdvertisementUtilities.advertisementToXmlText(Advertisement advertisement)
          Deprecated. Equivalent to Advertisement.toString()
 


JXTA J2SE