Project JXTA

net.jxta.protocol
Class RdvAdvertisement

java.lang.Object
  |
  +--net.jxta.document.Advertisement
        |
        +--net.jxta.protocol.RdvAdvertisement

public abstract class RdvAdvertisement
extends Advertisement

This class defines a Rendezvous Advertisement

The default behavior of this abstract class is to simple be a place holder for the PeerGroup Id, a Peer Id of the rendezvous and its name. No XML document is processed. That has to be done in the class that implements RdvAdvertisement.

 <?xml version="1.0"?>
 <JxtaRdv>
   <RdvGrouId> UUID </RdvGroupId>
   <RdvPeerId> UUID </RdvPeerId>
   <name> optional symbolic name than can be used by
      any search engine </name>
 </JxtaPipe>

Note that other tags can be provided by the application for its own profit. Those extra tags are not interpreted by the PipeService Service.

Since:
JXTA 1.0

Constructor Summary
RdvAdvertisement()
           
 
Method Summary
static java.lang.String getAdvertisementType()
          get the adv type
 PeerGroupID getGroupID()
          get the group id
 java.lang.String getName()
          get the symbolic name associated with the rdv
 PeerID getPeerID()
          get the rdv peer id
 void setGroupID(PeerGroupID id)
          set the group Id
 void setName(java.lang.String n)
          set the symbolic name associated with the rdv
 void setPeerID(PeerID id)
          set the peer Id
 
Methods inherited from class net.jxta.document.Advertisement
getDocument, getLocalExpirationTime, setExpiration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RdvAdvertisement

public RdvAdvertisement()
Method Detail

getAdvertisementType

public static java.lang.String getAdvertisementType()
get the adv type
Returns:
String RdvAdvertisement type
Since:
JXTA 1.0

getGroupID

public PeerGroupID getGroupID()
get the group id
Returns:
String PeerGroupID
Since:
JXTA 1.0

setGroupID

public void setGroupID(PeerGroupID id)
set the group Id
Returns:
String PeerGroupId
Since:
JXTA 1.0

getPeerID

public PeerID getPeerID()
get the rdv peer id
Returns:
String PeerID
Since:
JXTA 1.0

setPeerID

public void setPeerID(PeerID id)
set the peer Id
Returns:
String PeerId
Since:
JXTA 1.0

getName

public java.lang.String getName()
get the symbolic name associated with the rdv
Returns:
String the name field.
Since:
JXTA 1.0

setName

public void setName(java.lang.String n)
set the symbolic name associated with the rdv
Parameters:
n - the name this rdv adv should have.
Since:
JXTA 1.0

Project JXTA