request.html

jsip开发文档,对于开发SIP软电话和presence服务很有用

 respectively, the method and sequence number from the CSeq and the 
 sequence number from the RSeq header of the reliable provisional response. 
 PRACK requests MAY contain bodies, which are interpreted according to 
 their type and disposition.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.message.Request.PRACK">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="UPDATE"><!-- --></A><H3>
UPDATE</H3>
<PRE>
static final java.lang.String <B>UPDATE</B></PRE>
<DL>
<DD>UPDATE is an extension method that allows a client to update parameters 
 of a session (such as the set of media streams and their codecs) but has 
 no impact on the state of a dialog. In that sense, it is like a re-INVITE, 
 but unlike re-INVITE, it can be sent before the initial INVITE has been 
 completed. This makes it very useful for updating session parameters 
 within early dialogs. Operation of this extension is straightforward, the 
 caller begins with an INVITE transaction, which proceeds normally. Once a 
 dialog is established, the caller can generate an UPDATE method that 
 contains an SDP offer for the purposes of updating the session. The 
 response to the UPDATE method contains the answer. The Allow header 
 field is used to indicate support for the UPDATE method. There are 
 additional constraints on when UPDATE can be used, based on the 
 restrictions of the offer/answer model. Although UPDATE can be used on 
 confirmed dialogs, it is RECOMMENDED that a re-INVITE be used instead. 
 This is because an UPDATE needs to be answered immediately, ruling out 
 the possibility of user approval. Such approval will frequently be needed, 
 and is possible with a re-INVITE.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.message.Request.UPDATE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="PUBLISH"><!-- --></A><H3>
PUBLISH</H3>
<PRE>
static final java.lang.String <B>PUBLISH</B></PRE>
<DL>
<DD>PUBLISH is an extension method that allows a client to publish event state
 (such as presence information). It is sent outside of any dialog, and is not
 dialog creating. PUBLISH is similar to REGISTER in that it allows a user 
 to create, modify, and remove state in another entity which manages this
 state on behalf of the user.  Addressing a PUBLISH request is identical 
 to addressing a SUBSCRIBE request.  The Request-URI of a PUBLISH request 
 is populated with the address of the resource for which the user wishes 
 to publish event state.  The user may in turn have multiple User Agents 
 or endpoints that publish event state. Each endpoint may publish its own 
 unique state, out of which the event state compositor generates the 
 composite event state of the resource.  In addition to a particular 
 resource, all published event state is associated with a specific event 
 package. Through a subscription to that event package, the user is able 
 to discover the composite event state of all of the active publications.
<p>
 PUBLISH requests create soft state in the event state compositor. This 
 event soft state has a defined lifetime and will expire after a 
 negotiated amount of time, requiring the publication to be refreshed 
 by subsequent PUBLISH requests. There may also be event hard state 
 provisioned for each resource for a particular event package. This event 
 state represents the resource state that is present at all times, and 
 does not expire.The event state compositor may use event hard state in 
 the absence of, or in addition to, event soft state provided through 
 the PUBLISH mechanism.
 <p>
 Clients may probe for the support of PUBLISH using theOPTIONS request. 
 The presence of "PUBLISH" in the "Allow" header field in a response to 
 an OPTIONS request indicates support for the PUBLISH method. In addition, 
 the "Allow-Events" header field indicates the supported event packages.
 <p>
 A PUBLISH request does not establish a dialog. A UAC MAY include a
 Route header field in a PUBLISH request based on a pre-existing route set.
 The Record-Route header field has no meaning in PUBLISH requests or 
 responses, and MUST be ignored if present. In particular, the UAC MUST 
 NOT create a new route set based on the presence or absence of a 
 Record-Route header field in any response to a PUBLISH request. The 
 PUBLISH request MAY contain a Contact header field, but including
 one in a PUBLISH request has no meaning in the event publication
 context and will be ignored. A PUBLISH request may be sent within an 
 existing dialog.  In that case, the request is received in the context 
 of any media session or sessions associated with that dialog. A new 
 PUBLISH should not be sent (not a re-transmission) for the same 
 Request-URI, until they have received a final response for the previous 
 one or the previous PUBLISH request has timed out.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>v1.2</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.message.Request.PUBLISH">Constant Field Values</A></DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getMethod()"><!-- --></A><H3>
getMethod</H3>
<PRE>
java.lang.String <B>getMethod</B>()</PRE>
<DL>
<DD>Gets method string of this Request message.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the method of this Request message.</DL>
</DD>
</DL>
<HR>

<A NAME="setMethod(java.lang.String)"><!-- --></A><H3>
setMethod</H3>
<PRE>
void <B>setMethod</B>(java.lang.String&nbsp;method)
               throws java.text.ParseException</PRE>
<DL>
<DD>Sets the method of Request to the newly supplied value. The standard 
 RFC3261 methods are REGISTER for registering contact information, INVITE, 
 ACK, and CANCEL for setting up sessions, BYE for terminating sessions, and
 OPTIONS for querying servers about their capabilities.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>method</CODE> - - the new string value of the method of Request
<DT><B>Throws:</B>
<DD><CODE>java.text.ParseException</CODE> - which signals that an error has been reached
 unexpectedly while parsing the method value.</DL>
</DD>
</DL>
<HR>

<A NAME="getRequestURI()"><!-- --></A><H3>
getRequestURI</H3>
<PRE>
<A HREF="../../../javax/sip/address/URI.html" title="interface in javax.sip.address">URI</A> <B>getRequestURI</B>()</PRE>
<DL>
<DD>Gets the URI Object identifying the request URI of this Request, which 
 indicates the user or service to which this request is addressed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Request URI of Request</DL>
</DD>
</DL>
<HR>

<A NAME="setRequestURI(javax.sip.address.URI)"><!-- --></A><H3>
setRequestURI</H3>
<PRE>
void <B>setRequestURI</B>(<A HREF="../../../javax/sip/address/URI.html" title="interface in javax.sip.address">URI</A>&nbsp;requestURI)</PRE>
<DL>
<DD>Sets the RequestURI of Request. The Request-URI is a SIP or SIPS URI 
 or a general URI. It indicates the user or service to which this request 
 is being addressed. SIP elements MAY support Request-URIs with schemes 
 other than "sip" and "sips", for example the "tel" URI scheme. SIP 
 elements MAY translate non-SIP URIs using any mechanism at their disposal, 
 resulting in SIP URI, SIPS URI, or some other scheme.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>requestURI</CODE> - - the new Request URI of this request message</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>JSIP API v1.2<br><font size=-1>November 2006</font></b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../javax/sip/message/MessageFactory.html" title="interface in javax.sip.message"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../javax/sip/message/Response.html" title="interface in javax.sip.message"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?javax/sip/message/Request.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Request.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<center>If you have any comments, please mail them to <a href=mailto:[e-mail]>[e-mail]</a> after subscribing at <a href=http://archives.java.sun.com>http://archives.java.sun.com</a><br><a href=../../../copyright.html>Copyright</a> - 2006 BEA Systems and Sun Microsystems</center>
</BODY>
</HTML>