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>

Since:

JXTA 1.0

Version:

$Revision: 1.4 $

Field Summary

static java.lang.String	GroupIDTag
static java.lang.String	NameTag
static java.lang.String	PeerIDTag

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

clone, getDocument, getID

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NameTag

public static final java.lang.String NameTag

PeerIDTag

public static final java.lang.String PeerIDTag

GroupIDTag

public static final java.lang.String GroupIDTag

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