Project JXTA

net.jxta.protocol
Class PeerInfoQueryMessage

java.lang.Object
  |
  +--net.jxta.protocol.PeerInfoQueryMessage

public abstract class PeerInfoQueryMessage
extends java.lang.Object

This abstract class define the PeerInfoService Query message

This message is part of the Peer PeerInfoService protocol

 <xs:element name="PeerInfoQueryMessage" type="jxta:PeerInfoQueryMessage"/>

 <xs:complexType name="PeerInfoQueryMessage">
     <xs:element name="sourcePid" type="xs:anyURI"/>
     <xs:element name="targetPid" type="xs:anyURI"/>
     <!-- if no present then the response is the general peerinfo -->
     <xs:element name="request" type="xs:anyType" minOccurs="0"/>
 </xs:complexType>
 

Since:
JXTA 1.0

Constructor Summary
PeerInfoQueryMessage()
           
 
Method Summary
abstract  Document getDocument(MimeMediaType encodeAs)
           
static java.lang.String getMessageType()
          returns the Message type
 Element getRequest()
          returns the request
 ID getSourcePid()
          returns the sender's pid
 ID getTargetPid()
          returns the target pid
 void setRequest(Element request)
          sets the request
 void setSourcePid(ID pid)
          sets the sender's pid
 void setTargetPid(ID pid)
          sets the target's pid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PeerInfoQueryMessage

public PeerInfoQueryMessage()
Method Detail

getMessageType

public static java.lang.String getMessageType()
returns the Message type
Returns:
a string
Since:
JXTA 1.0

getSourcePid

public ID getSourcePid()
returns the sender's pid
Returns:
a string representing the peer's id
Since:
JXTA 1.0

setSourcePid

public void setSourcePid(ID pid)
sets the sender's pid
Parameters:
pid - a string representing a peer's id
Since:
JXTA 1.0

getTargetPid

public ID getTargetPid()
returns the target pid
Returns:
a string representing the peer's id
Since:
JXTA 1.0

setTargetPid

public void setTargetPid(ID pid)
sets the target's pid
Parameters:
pid - a string representing a peer's id
Since:
JXTA 1.0

getRequest

public Element getRequest()
returns the request
Returns:
a structured document representing request
Since:
JXTA 1.0

setRequest

public void setRequest(Element request)
sets the request
Parameters:
request - a structured document representing a peerinfo request
Since:
JXTA 1.0

getDocument

public abstract Document getDocument(MimeMediaType encodeAs)

Project JXTA