Project JXTA

net.jxta.protocol
Class LimitedRangeRdvMessage

java.lang.Object
  extended by net.jxta.protocol.LimitedRangeRdvMessage

public abstract class LimitedRangeRdvMessage
extends Object

This class defines the Limited Range Rendezvous message.

Since:
JXTA 1.0
See Also:
net.jxta.impl.protocol.LimitedRangeRdvMsg

Field Summary
static int BOTH
           
static String DirTag
           
static int DOWN
           
static String Name
           
static String SrcPeerIDTag
           
static String SrcRouteAdvTag
           
static String SrcSvcNameTag
           
static String SrcSvcParamsTag
           
static String TTLTag
           
static int UP
           
 
Constructor Summary
LimitedRangeRdvMessage()
           
 
Method Summary
static String getAdvertisementType()
          All messages have a type (in xml this is !
 int getDirection()
          Get the direction the message must take
abstract  Document getDocument(MimeMediaType asMimeType)
          Write advertisement into a document. asMimeType is a mime media-type specification and provides the form of the document which is being requested.
 String getSrcPeerID()
          Get the Source PeerID
 String getSrcRouteAdv()
          Get the Source RouteAdvertisement (listening for the response)
 String getSrcSvcName()
          Get the Source Service Name (listening for the response)
 String getSrcSvcParams()
          Get the Source Service Param (listening for the response)
 int getTTL()
          Get the TTL
 void setDirection(int dir)
          set the Direction of the message
 void setSrcPeerID(String srcPeerID)
          set the Source PeerID
 void setSrcRouteAdv(String srcRouteAdv)
          set the Source Route Advertisement (listening for the response)
 void setSrcSvcName(String srcSvcName)
          set the Source Service Name (listening for the response)
 void setSrcSvcParams(String srcSvcParams)
          set the Source Service Params (listening for the response)
 void setTTL(int ttl)
          set the TTL
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Name

public static final String Name
See Also:
Constant Field Values

TTLTag

public static final String TTLTag
See Also:
Constant Field Values

DirTag

public static final String DirTag
See Also:
Constant Field Values

SrcSvcNameTag

public static final String SrcSvcNameTag
See Also:
Constant Field Values

SrcSvcParamsTag

public static final String SrcSvcParamsTag
See Also:
Constant Field Values

SrcPeerIDTag

public static final String SrcPeerIDTag
See Also:
Constant Field Values

SrcRouteAdvTag

public static final String SrcRouteAdvTag
See Also:
Constant Field Values

UP

public static final int UP
See Also:
Constant Field Values

DOWN

public static final int DOWN
See Also:
Constant Field Values

BOTH

public static final int BOTH
See Also:
Constant Field Values
Constructor Detail

LimitedRangeRdvMessage

public LimitedRangeRdvMessage()
Method Detail

getAdvertisementType

public static String getAdvertisementType()
All messages have a type (in xml this is !doctype) which identifies the message

Returns:
String "jxta:LimitedRangeRdvMessage"
Since:
JXTA 1.0

getTTL

public int getTTL()
Get the TTL

Returns:
int Time To Live
Since:
JXTA 1.0

setTTL

public void setTTL(int ttl)
set the TTL

Parameters:
ttl - TTL
Since:
JXTA 1.0

getDirection

public int getDirection()
Get the direction the message must take

Returns:
int UP, DOWN or BOTH
Since:
JXTA 1.0

setDirection

public void setDirection(int dir)
set the Direction of the message

Parameters:
dir - direction
Since:
JXTA 1.0

getSrcSvcName

public String getSrcSvcName()
Get the Source Service Name (listening for the response)

Returns:
String Source Service Name
Since:
JXTA 1.0

setSrcSvcName

public void setSrcSvcName(String srcSvcName)
set the Source Service Name (listening for the response)

Parameters:
srcSvcName - Source Service Name
Since:
JXTA 1.0

getSrcSvcParams

public String getSrcSvcParams()
Get the Source Service Param (listening for the response)

Returns:
String Source Service Param
Since:
JXTA 1.0

setSrcSvcParams

public void setSrcSvcParams(String srcSvcParams)
set the Source Service Params (listening for the response)

Parameters:
srcSvcParams - Source Service Params
Since:
JXTA 1.0

getSrcPeerID

public String getSrcPeerID()
Get the Source PeerID

Returns:
String Source PeerID
Since:
JXTA 1.0

setSrcPeerID

public void setSrcPeerID(String srcPeerID)
set the Source PeerID

Parameters:
srcPeerID - Source PeerID
Since:
JXTA 1.0

getSrcRouteAdv

public String getSrcRouteAdv()
Get the Source RouteAdvertisement (listening for the response)

Returns:
String Source RouteAdvertisement
Since:
JXTA 1.0

setSrcRouteAdv

public void setSrcRouteAdv(String srcRouteAdv)
set the Source Route Advertisement (listening for the response)

Parameters:
srcRouteAdv - Source Route Advertisement
Since:
JXTA 1.0

getDocument

public abstract Document getDocument(MimeMediaType asMimeType)
Write advertisement into a document. asMimeType is a mime media-type specification and provides the form of the document which is being requested. Two standard document forms are defined. "text/text" encodes the document in a form nice for printing out, and "text/xml" which provides an XML representation.

Parameters:
asMimeType - mime-type format requested
Returns:
Document representation of the document as an advertisement
Since:
JXTA 1.0

JXTA J2SE