|
JXTA | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.jxta.impl.protocol.LeaseRequestMsg
public class LeaseRequestMsg
A Leasing Protocol Request Message.
<xs:complexType name="LeaseRequestMessage">
<xs:sequence>
<xs:element name="Credential" type="jxta:Cred" />
<xs:element name="ClientAdv" minOccurs="0" >
<xs:complexType>
<xs:complexContent>
<xs:extension base="jxta:PA">
<xs:attribute name="expiration" use="required" type="xs:unsignedLong" />
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="Option" minOccurs="0" maxOccurs="unbounded" type="xs:anyType" />
</xs:sequence>
<xs:attribute name="client_id" use="required" type="jxta:JXTAID" />
<xs:attribute name="requested_lease" type="xs:unsignedLong" />
<xs:attribute name="server_adv_gen" type="jxta:uuid" />
<xs:attribute name="referral_advs" type="xs:unsignedInt" />
</xs:complexType>
Constructor Summary | |
---|---|
LeaseRequestMsg()
New LeaseRequestMsg |
|
LeaseRequestMsg(Element root)
Construct from a XLMElement |
Method Summary | |
---|---|
Object |
clone()
|
ID |
getClientID()
Returns the ID of the client making this request. |
XMLElement |
getCredential()
Returns the credential of the client making this request in XML format. |
Document |
getDocument(MimeMediaType mediaType)
|
static String |
getMessageType()
Our DOCTYPE |
int |
getReferralAdvs()
Returns the number of referral advertisements requested by the client. |
long |
getRequestedLease()
Return the duration of the lease being requested. |
UUID |
getServerAdvGen()
Returns the advertisement generation of the server advertisement which is known to the client. |
protected boolean |
handleElement(XMLElement elem)
|
void |
setClientID(ID clientID)
Sets the ID of the client making this request. |
void |
setCredential(XMLElement newCred)
Sets the credential of the client making this request in XML format. |
void |
setReferralAdvs(int referralAdvs)
Sets the number of referral advertisements requested by the client. |
void |
setRequestedLease(long requestedLease)
Set the duration of the lease being requested. |
void |
setServerAdvGen(UUID serverAdvGen)
Sets the advertisement generation of the server advertisement which is known to the client. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LeaseRequestMsg()
public LeaseRequestMsg(Element root)
Method Detail |
---|
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
public ID getClientID()
public void setClientID(ID clientID)
clientID
- ID of the client.public UUID getServerAdvGen()
null
to indicate that the client
does not have a previous version of the server advertisement.
public void setServerAdvGen(UUID serverAdvGen)
null
to indicate that the client
does not have a previous version of the server advertisement.
serverAdvGen
- The server advertisement generation.public long getRequestedLease()
Long.MIN_VALUE
which indicates that no
lease is being requested.
public void setRequestedLease(long requestedLease)
Long.MIN_VALUE
which indicates that no
lease is being requested.
requestedLease
- The duration of the lease being requested.public int getReferralAdvs()
Integer.MIN_VALUE
which indicates
that the default number is requested.
public void setReferralAdvs(int referralAdvs)
Integer.MIN_VALUE
which indicates
that the default number is requested.
referralAdvs
- The number of referral advertisements requested.public XMLElement getCredential()
null
to indicate that no credential was provided.public void setCredential(XMLElement newCred)
newCred
- The credential associated with this request if any. May
be null
to indicate that no credential is being provided.public static String getMessageType()
protected boolean handleElement(XMLElement elem)
public Document getDocument(MimeMediaType mediaType)
|
JXSE | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |