Project JXTA

net.jxta.impl.rendezvous
Class RendezVousPropagateMessage

java.lang.Object
  extended bynet.jxta.impl.rendezvous.RendezVousPropagateMessage

public class RendezVousPropagateMessage
extends Object

This class defines the wire format of the Propagation header for messages.


Field Summary
static String DestSNameTag
           
static String DestSParamTag
           
static String MSG_NAME
           
static String MsgIdTag
           
static String Name
          Description of the Field
static String PathTag
           
static String TTLTag
           
 
Constructor Summary
RendezVousPropagateMessage()
          Constructor for the RendezVousPropagateMessage object
RendezVousPropagateMessage(Element root)
          Constructor for the RendezVousPropagateMessage object
 
Method Summary
 void addVisited(URI location)
          Adds a location to the Visited Set
 String getDestSName()
           
 String getDestSParam()
           
 Document getDocument(MimeMediaType encodeAs)
           
 UUID getMsgId()
           
 URI[] getPath()
          Returns the path which this message has travelled.
 int getTTL()
          Gets the TTL attribute of the RendezVousPropagateMessage object
protected  boolean handleElement(Element raw)
          {@inheritDoc}
 boolean isVisited(URI location)
          Returns true if the specified location is in the visited Set.
 void setDestSName(String sName)
           
 void setDestSParam(String sParam)
           
 void setMsgId(UUID id)
           
 void setTTL(int t)
          Sets the TTL attribute of the RendezVousPropagateMessage object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MSG_NAME

public static final String MSG_NAME
See Also:
Constant Field Values

MsgIdTag

public static final String MsgIdTag
See Also:
Constant Field Values

DestSNameTag

public static final String DestSNameTag
See Also:
Constant Field Values

DestSParamTag

public static final String DestSParamTag
See Also:
Constant Field Values

TTLTag

public static final String TTLTag
See Also:
Constant Field Values

PathTag

public static final String PathTag
See Also:
Constant Field Values

Name

public static final String Name
Description of the Field

See Also:
Constant Field Values
Constructor Detail

RendezVousPropagateMessage

public RendezVousPropagateMessage()
Constructor for the RendezVousPropagateMessage object


RendezVousPropagateMessage

public RendezVousPropagateMessage(Element root)
Constructor for the RendezVousPropagateMessage object

Method Detail

handleElement

protected boolean handleElement(Element raw)
{@inheritDoc}


getMsgId

public UUID getMsgId()

setMsgId

public void setMsgId(UUID id)

getDestSName

public String getDestSName()

setDestSName

public void setDestSName(String sName)

getDestSParam

public String getDestSParam()

setDestSParam

public void setDestSParam(String sParam)

getTTL

public int getTTL()
Gets the TTL attribute of the RendezVousPropagateMessage object

Returns:
The TTL value

setTTL

public void setTTL(int t)
Sets the TTL attribute of the RendezVousPropagateMessage object

Parameters:
t - The new TTL value

addVisited

public void addVisited(URI location)
Adds a location to the Visited Set

Parameters:
location - which was visited.

isVisited

public boolean isVisited(URI location)
Returns true if the specified location is in the visited Set.

Parameters:
location - The location to check
Returns:
true if specified location has been visited.

getPath

public URI[] getPath()
Returns the path which this message has travelled.

Returns:
the path this message travelled.

getDocument

public Document getDocument(MimeMediaType encodeAs)

JXTA J2SE