📄 message.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>
Message (JSIP API v1.2)
</TITLE>
<META NAME="keywords" CONTENT="javax.sip.message.Message interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Message (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">
PREV CLASS
<A HREF="../../../javax/sip/message/MessageFactory.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/Message.html" target="_top"><B>FRAMES</B></A>
<A HREF="Message.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | 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 Message</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable, java.io.Serializable</DD>
</DL>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../javax/sip/message/Request.html" title="interface in javax.sip.message">Request</A>, <A HREF="../../../javax/sip/message/Response.html" title="interface in javax.sip.message">Response</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Message</B><DT>extends java.lang.Cloneable, java.io.Serializable</DL>
</PRE>
<P>
A SIP message is either a request from a client to a server, or a response from a server to a client. Both Request and Response messages use the basic format of <a href ="http://www.ietf.org/rfc/rfc2822.txt"> RFC 2822</a>, even though the syntax differs in character set and syntax specifics. (SIP allows header fields that would not be valid RFC 2822 header fields, for example.) Both types of messages consist of a method name, address and protocol version, one or more header fields which describe the routing of the message, and an optional message-body. The message-body contains a session description in a format such as Session Description Protocol see <a href ="http://jcp.org/jsr/detail/141.jsp">JSR 141</a>. <p> This interface contains common elements of both Request and Response such as: <ul> <li> Generic accessor functions to headers. <li> Convenience accessor to the expiration value of the message. <li> Convenience header accessor methods for the body content type, language, disposition and length. <li> Accessor methods to the body content itself. </ul> <p> Although the SIP Protocol allows headers of a given kind to be interspaced with headers of different kinds, an implementation of this specification is required to organize headers so that headers that can appear multiple times in a SIP Message (such as the Via header) are grouped together and can be retrieved collectively and iterated over. Although an implementation may use short forms internally, the specification refers to all headers by their long form names.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>BEA Systems, NIST</DD>
<DT><B>See Also:</B><DD><A HREF="../../../javax/sip/message/Request.html" title="interface in javax.sip.message"><CODE>Request</CODE></A>,
<A HREF="../../../javax/sip/message/Response.html" title="interface in javax.sip.message"><CODE>Response</CODE></A>,
<A HREF="../../../javax/sip/header/Header.html" title="interface in javax.sip.header"><CODE>Header</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_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>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#addFirst(javax.sip.header.Header)">addFirst</A></B>(<A HREF="../../../javax/sip/header/Header.html" title="interface in javax.sip.header">Header</A> header)</CODE>
<BR>
Adds the new Header to the head of the existing list of Headers contained in this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#addHeader(javax.sip.header.Header)">addHeader</A></B>(<A HREF="../../../javax/sip/header/Header.html" title="interface in javax.sip.header">Header</A> header)</CODE>
<BR>
Adds the new Header to the existing list of Headers contained in this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#addLast(javax.sip.header.Header)">addLast</A></B>(<A HREF="../../../javax/sip/header/Header.html" title="interface in javax.sip.header">Header</A> header)</CODE>
<BR>
Adds the new Header to the end of existing list of Headers contained in this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#clone()">clone</A></B>()</CODE>
<BR>
Creates and returns a deep copy of the Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object object)</CODE>
<BR>
Compare this SIP Message for equality with another.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getContent()">getContent</A></B>()</CODE>
<BR>
Gets the body content of the Message as an Object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/sip/header/ContentDispositionHeader.html" title="interface in javax.sip.header">ContentDispositionHeader</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getContentDisposition()">getContentDisposition</A></B>()</CODE>
<BR>
Gets the ContentDispositionHeader of this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/sip/header/ContentEncodingHeader.html" title="interface in javax.sip.header">ContentEncodingHeader</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getContentEncoding()">getContentEncoding</A></B>()</CODE>
<BR>
Gets the ContentEncodingHeader of this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/sip/header/ContentLanguageHeader.html" title="interface in javax.sip.header">ContentLanguageHeader</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getContentLanguage()">getContentLanguage</A></B>()</CODE>
<BR>
Gets the ContentLanguageHeader of this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/sip/header/ContentLengthHeader.html" title="interface in javax.sip.header">ContentLengthHeader</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getContentLength()">getContentLength</A></B>()</CODE>
<BR>
Gets the ContentLengthHeader of the body content of this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/sip/header/ExpiresHeader.html" title="interface in javax.sip.header">ExpiresHeader</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getExpires()">getExpires</A></B>()</CODE>
<BR>
Gets the ExpiresHeader of this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/sip/header/Header.html" title="interface in javax.sip.header">Header</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getHeader(java.lang.String)">getHeader</A></B>(java.lang.String headerName)</CODE>
<BR>
Gets the Header of the specified name in this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.ListIterator</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getHeaderNames()">getHeaderNames</A></B>()</CODE>
<BR>
Gets a ListIterator over the set of all all the header names in this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.ListIterator</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getHeaders(java.lang.String)">getHeaders</A></B>(java.lang.String headerName)</CODE>
<BR>
Gets a ListIterator over all the Headers of the newly specified name in this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getRawContent()">getRawContent</A></B>()</CODE>
<BR>
Gets the body content of the Message as a byte array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getSIPVersion()">getSIPVersion</A></B>()</CODE>
<BR>
Gets the protocol version of SIP being used by this Message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.ListIterator</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/message/Message.html#getUnrecognizedHeaders()">getUnrecognizedHeaders</A></B>()</CODE>
<BR>
Returns a ListIterator over all the UnrecognizedHeaders in this Message.</TD>
</TR>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -