📄 response.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0) on Wed Nov 15 07:55:49 PST 2006 -->
<TITLE>
Response (JSIP API v1.2)
</TITLE>
<META NAME="keywords" CONTENT="javax.sip.message.Response interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Response (JSIP API v1.2)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" 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_top_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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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">
<A HREF="../../../javax/sip/message/Request.html" title="interface in javax.sip.message"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/sip/message/Response.html" target="_top"><B>FRAMES</B></A>
<A HREF="Response.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.sip.message</FONT>
<BR>
Interface Response</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../../javax/sip/message/Message.html" title="interface in javax.sip.message">Message</A>, java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Response</B><DT>extends <A HREF="../../../javax/sip/message/Message.html" title="interface in javax.sip.message">Message</A></DL>
</PRE>
<P>
A Response message is sent by a recipient of Request once it has received and interpreted the Request. Responses are contain a Status-Code and a Reason-Phrase, as well as Headers and a possible message body. <p> The Status-Code is a 3-digit integer result code that indicates the outcome of the attempt to understand and satisfy the Request. The Reason-Phrase is intended to give a short textual description of the Status-Code. The Status-Code is intended for use by automata, whereas the Reason-Phrase is intended for the human user. The client is not required to examine or display the Reason-Phrase. <p> RFC3261 defines status codes in the following classes: <ul> <li><b>1xx: Provisional</b> -- request received, continuing to process the request; Provisional responses, also known as informational responses, indicate that the server contacted is performing some further action and does not yet have a definitive response. <ul> <li> This specification also supports the delivery of reliable provisional responses as defined in <a href = "http://www.ietf.org/rfc/rfc3262.txt">RFC 3262</a>. When the UAC creates a new request, it can insist on reliable delivery of provisional responses for that request. To do that, it inserts a Require header field with the option tag 100rel into the request. A Require header with the value <code>100rel</code> MUST NOT be present in any requests excepting INVITE, although other extensions to SIP may allow its usage with other request methods. If the UAC does not wish to insist on usage of reliable provisional responses, but merely indicate that it supports them if the UAS needs to send one, a Supported header MUST be included in the request with the option tag <code>100rel</code>. The UAC SHOULD include this in all INVITE requests. <p> A UAS MAY send any non-100 provisional response to INVITE reliably, so long as the initial INVITE request (the request whose provisional response is being sent reliably) contained a Supported header field with the option tag <code>100rel</code>. The provisional response to be sent reliably is constructed by the UAS and MUST contain a Require header field containing the option tag <code>100rel</code>, and MUST include an RSeq header field. Retransmissions of the reliable provisional response cease when a matching PRACK is received by the UA core. PRACK is like any other request within a dialog, and is treated likewise. A matching PRACK is defined as one within the same dialog as the response, and whose method, CSeq-num, and RSeq-num in the RAck header field match, respectively, the method and sequence number from the CSeq and the sequence number from the RSeq of the reliable provisional response. </ul> <li><b>2xx: Success</b> -- the action was successfully received, understood, and accepted. <li><b>3xx: Redirection</b> -- further action needs to be taken in order to complete the request; 3xx responses give information about the user's new location, or about alternative services that might be able to satisfy the call. <li><b>4xx: Client Error</b> -- the request contains bad syntax or cannot be fulfilled at this server; 4xx responses are definite failure responses from a particular server. The client SHOULD NOT retry the same request without modification. However, the same request to a different server might be successful. <li><b>5xx: Server Error</b> -- the server failed to fulfill an apparently valid request; 5xx responses are failure responses given when a server itself has erred. <li><b>6xx: Global Failure</b> -- the request cannot be fulfilled at any server; 6xx responses indicate that a server has definitive information about a particular user, not just the particular instance indicated in the Request-URI. </ul> SIP status codes are extensible. The response codes are consistent with, and extend, <a href = "http://www.ietf.org/rfc/rfc2616.txt">HTTP/1.1</a> response codes. Not all HTTP/1.1 response codes are appropriate, and only those that are appropriate are given here. Other HTTP/1.1 response codes SHOULD NOT be used. Also, SIP defines a new class, 6xx. <p> SIP applications are not required to understand the meaning of all registered response codes, though such understanding is obviously desirable. However, applications must understand the class of any status code, as indicated by the first digit and outlined above. Applications treat any unrecognized status code as being equivalent to the x00 status code of that class, with the exception that an unrecognized status code must not be cached. For example, if a client receives an unrecognized status code of 431, it can safely assume that there was something wrong with its request and treat the Response as if it had received a BAD_REQUEST(400) status code. In such cases, user agents should present to the user the message body returned with the Response, since that message body is likely to include human-readable information which will explain the unusual status. <p> This specification supports the response codes defined in RFC3261 and also the response code extensions for the event notification framework and PUBLISH, documented in <a href = "http://www.ietf.org/rfc/rfc3262.txt">RFC3265</a> and <a href = "http://www.ietf.org/rfc/rfc3909.txt">RFC3909</a>, these are highlighted in italic. Class status codes (x00, i.e. 100) are are highlighted in bold. </p> <table BORDER WIDTH="75%" > <tr> <td><b>Class</b></td> <td><b>Code</b></td> </tr> <tr> <td>PROVISIONAL (1xx)</td> <td> <LI><b>TRYING - 100</b></LI> <LI>RINGING - 180</LI> <LI>CALL_IS_BEING_FORWARDED - 181</LI> <LI>QUEUED - 182</LI> <li>SESSION_PROGRESS - 183</li> </td> </tr> <tr> <td>SUCCESS (2xx)</td> <td> <LI><b>OK - 200</b></LI> <LI><i>ACCEPTED - 202 (Extension RFC3265)</i></LI> </td> </tr> <tr> <td>REDIRECTION (3xx)</td> <td> <LI><b>MULTIPLE_CHOICES - 300</b></LI> <LI>MOVED_PERMANENTLY - 301</LI> <LI>MOVED_TEMPORARILY - 302</LI> <LI>USE_PROXY - 305</LI> <LI>ALTERNATIVE_SERVICE - 380</LI> </td> </tr> <tr> <td>CLIENT_ERROR (4xx)</td> <td> <LI><b>BAD_REQUEST - 400</b></LI> <LI>UNAUTHORIZED - 401</LI> <LI>PAYMENT_REQUIRED - 402</LI> <LI>FORBIDDEN - 403</LI> <LI>NOT_FOUND - 404</LI> <LI>METHOD_NOT_ALLOWED - 405</LI> <LI>NOT_ACCEPTABLE - 406</LI> <LI>PROXY_AUTHENTICATION_REQUIRED - 407</LI> <LI>REQUEST_TIMEOUT - 408</LI> <LI>GONE - 410</LI> <LI><i>CONDITIONAL_REQUEST_FAILED - 412 (Extension RFC3909)<i> <LI>REQUEST_ENTITY_TOO_LARGE - 413 <LI>REQUEST_URI_TOO_LONG - 414 <LI>UNSUPPORTED_MEDIA_TYPE - 415</LI> <LI>UNSUPPORTED_URI_SCHEME - 416 <LI>BAD_EXTENSION - 420</LI> <LI>EXTENSION_REQUIRED - 421 <LI>INTERVAL_TOO_BRIEF - 423 <LI>TEMPORARILY_UNAVAILABLE - 480</LI> <LI>CALL_OR_TRANSACTION_DOES_NOT_EXIST - 481</LI> <LI>LOOP_DETECTED - 482</LI> <LI>TOO_MANY_HOPS - 483</LI> <LI>ADDRESS_INCOMPLETE - 484</LI> <LI>AMBIGUOUS - 485</LI> <LI>BUSY_HERE - 486</LI> <LI>REQUEST_TERMINATED - 487 <LI>NOT_ACCEPTABLE_HERE - 488 <LI><i>BAD EVENT - 489 (Extension RFC3265)<i></LI> <LI>REQUEST_PENDING - 491 <LI>UNDECIPHERABLE - 493 </td> </tr> <tr> <td>SERVER_ERROR (5xx)</td> <td> <LI><b>SERVER_INTERNAL_ERROR - 500</b></LI> <LI>NOT_IMPLEMENTED - 501</LI> <LI>BAD_GATEWAY - 502</LI> <LI>SERVICE_UNAVAILABLE - 503</LI> <LI>SERVER_TIMEOUT - 504</LI> <LI>VERSION_NOT_SUPPORTED - 505</LI> <LI>MESSAGE_TOO_LARGE - 513 </td> </tr> <tr> <td>GLOBAL_ERROR (6xx)</td> <td> <LI><b>BUSY_EVERYWHERE - 600</b></LI> <LI>DECLINE - 603</LI> <LI>DOES_NOT_EXIST_ANYWHERE - 604</LI> <LI>SESSION_NOT_ACCEPTABLE - 606</LI> </td> </tr> </table>
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>BEA Systems, NIST</DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -