📄 header.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>
Header (JSIP API v1.2)
</TITLE>
<META NAME="keywords" CONTENT="javax.sip.header.Header interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Header (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/header/FromHeader.html" title="interface in javax.sip.header"><B>PREV CLASS</B></A>
<A HREF="../../../javax/sip/header/HeaderAddress.html" title="interface in javax.sip.header"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/sip/header/Header.html" target="_top"><B>FRAMES</B></A>
<A HREF="Header.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.header</FONT>
<BR>
Interface Header</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/header/AcceptEncodingHeader.html" title="interface in javax.sip.header">AcceptEncodingHeader</A>, <A HREF="../../../javax/sip/header/AcceptHeader.html" title="interface in javax.sip.header">AcceptHeader</A>, <A HREF="../../../javax/sip/header/AcceptLanguageHeader.html" title="interface in javax.sip.header">AcceptLanguageHeader</A>, <A HREF="../../../javax/sip/header/AlertInfoHeader.html" title="interface in javax.sip.header">AlertInfoHeader</A>, <A HREF="../../../javax/sip/header/AllowEventsHeader.html" title="interface in javax.sip.header">AllowEventsHeader</A>, <A HREF="../../../javax/sip/header/AllowHeader.html" title="interface in javax.sip.header">AllowHeader</A>, <A HREF="../../../javax/sip/header/AuthenticationInfoHeader.html" title="interface in javax.sip.header">AuthenticationInfoHeader</A>, <A HREF="../../../javax/sip/header/AuthorizationHeader.html" title="interface in javax.sip.header">AuthorizationHeader</A>, <A HREF="../../../javax/sip/header/CallIdHeader.html" title="interface in javax.sip.header">CallIdHeader</A>, <A HREF="../../../javax/sip/header/CallInfoHeader.html" title="interface in javax.sip.header">CallInfoHeader</A>, <A HREF="../../../javax/sip/header/ContactHeader.html" title="interface in javax.sip.header">ContactHeader</A>, <A HREF="../../../javax/sip/header/ContentDispositionHeader.html" title="interface in javax.sip.header">ContentDispositionHeader</A>, <A HREF="../../../javax/sip/header/ContentEncodingHeader.html" title="interface in javax.sip.header">ContentEncodingHeader</A>, <A HREF="../../../javax/sip/header/ContentLanguageHeader.html" title="interface in javax.sip.header">ContentLanguageHeader</A>, <A HREF="../../../javax/sip/header/ContentLengthHeader.html" title="interface in javax.sip.header">ContentLengthHeader</A>, <A HREF="../../../javax/sip/header/ContentTypeHeader.html" title="interface in javax.sip.header">ContentTypeHeader</A>, <A HREF="../../../javax/sip/header/CSeqHeader.html" title="interface in javax.sip.header">CSeqHeader</A>, <A HREF="../../../javax/sip/header/DateHeader.html" title="interface in javax.sip.header">DateHeader</A>, <A HREF="../../../javax/sip/header/ErrorInfoHeader.html" title="interface in javax.sip.header">ErrorInfoHeader</A>, <A HREF="../../../javax/sip/header/EventHeader.html" title="interface in javax.sip.header">EventHeader</A>, <A HREF="../../../javax/sip/header/ExpiresHeader.html" title="interface in javax.sip.header">ExpiresHeader</A>, <A HREF="../../../javax/sip/header/ExtensionHeader.html" title="interface in javax.sip.header">ExtensionHeader</A>, <A HREF="../../../javax/sip/header/FromHeader.html" title="interface in javax.sip.header">FromHeader</A>, <A HREF="../../../javax/sip/header/InReplyToHeader.html" title="interface in javax.sip.header">InReplyToHeader</A>, <A HREF="../../../javax/sip/header/MaxForwardsHeader.html" title="interface in javax.sip.header">MaxForwardsHeader</A>, <A HREF="../../../javax/sip/header/MimeVersionHeader.html" title="interface in javax.sip.header">MimeVersionHeader</A>, <A HREF="../../../javax/sip/header/MinExpiresHeader.html" title="interface in javax.sip.header">MinExpiresHeader</A>, <A HREF="../../../javax/sip/header/OrganizationHeader.html" title="interface in javax.sip.header">OrganizationHeader</A>, <A HREF="../../../javax/sip/header/PriorityHeader.html" title="interface in javax.sip.header">PriorityHeader</A>, <A HREF="../../../javax/sip/header/ProxyAuthenticateHeader.html" title="interface in javax.sip.header">ProxyAuthenticateHeader</A>, <A HREF="../../../javax/sip/header/ProxyAuthorizationHeader.html" title="interface in javax.sip.header">ProxyAuthorizationHeader</A>, <A HREF="../../../javax/sip/header/ProxyRequireHeader.html" title="interface in javax.sip.header">ProxyRequireHeader</A>, <A HREF="../../../javax/sip/header/RAckHeader.html" title="interface in javax.sip.header">RAckHeader</A>, <A HREF="../../../javax/sip/header/ReasonHeader.html" title="interface in javax.sip.header">ReasonHeader</A>, <A HREF="../../../javax/sip/header/RecordRouteHeader.html" title="interface in javax.sip.header">RecordRouteHeader</A>, <A HREF="../../../javax/sip/header/ReferToHeader.html" title="interface in javax.sip.header">ReferToHeader</A>, <A HREF="../../../javax/sip/header/ReplyToHeader.html" title="interface in javax.sip.header">ReplyToHeader</A>, <A HREF="../../../javax/sip/header/RequireHeader.html" title="interface in javax.sip.header">RequireHeader</A>, <A HREF="../../../javax/sip/header/RetryAfterHeader.html" title="interface in javax.sip.header">RetryAfterHeader</A>, <A HREF="../../../javax/sip/header/RouteHeader.html" title="interface in javax.sip.header">RouteHeader</A>, <A HREF="../../../javax/sip/header/RSeqHeader.html" title="interface in javax.sip.header">RSeqHeader</A>, <A HREF="../../../javax/sip/header/ServerHeader.html" title="interface in javax.sip.header">ServerHeader</A>, <A HREF="../../../javax/sip/header/SIPETagHeader.html" title="interface in javax.sip.header">SIPETagHeader</A>, <A HREF="../../../javax/sip/header/SIPIfMatchHeader.html" title="interface in javax.sip.header">SIPIfMatchHeader</A>, <A HREF="../../../javax/sip/header/SubjectHeader.html" title="interface in javax.sip.header">SubjectHeader</A>, <A HREF="../../../javax/sip/header/SubscriptionStateHeader.html" title="interface in javax.sip.header">SubscriptionStateHeader</A>, <A HREF="../../../javax/sip/header/SupportedHeader.html" title="interface in javax.sip.header">SupportedHeader</A>, <A HREF="../../../javax/sip/header/TimeStampHeader.html" title="interface in javax.sip.header">TimeStampHeader</A>, <A HREF="../../../javax/sip/header/ToHeader.html" title="interface in javax.sip.header">ToHeader</A>, <A HREF="../../../javax/sip/header/UnsupportedHeader.html" title="interface in javax.sip.header">UnsupportedHeader</A>, <A HREF="../../../javax/sip/header/UserAgentHeader.html" title="interface in javax.sip.header">UserAgentHeader</A>, <A HREF="../../../javax/sip/header/ViaHeader.html" title="interface in javax.sip.header">ViaHeader</A>, <A HREF="../../../javax/sip/header/WarningHeader.html" title="interface in javax.sip.header">WarningHeader</A>, <A HREF="../../../javax/sip/header/WWWAuthenticateHeader.html" title="interface in javax.sip.header">WWWAuthenticateHeader</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Header</B><DT>extends java.lang.Cloneable, java.io.Serializable</DL>
</PRE>
<P>
This interface is the super interface of all SIP headers supported explicitly by this specification. Extension Headers can be supported by this specification as required by extending the <A HREF="../../../javax/sip/header/ExtensionHeader.html" title="interface in javax.sip.header"><CODE>ExtensionHeader</CODE></A> assuming other endpoints understand the Header. This specification supports the following headers not defined in <a href = "http://www.ietf.org/rfc/rfc3261.txt">RFC3261</a> documented in the following standards track RFCs: <ul> <li> RAckHeader - this header is specific to the reliability of provisional Responses. This functionality is defined in <a href = "http://www.ietf.org/rfc/rfc3262.txt">RFC3262</a>. <li> RSeqHeader - this header is specific to the reliability of provisional Responses. This functionality is defined in <a href = "http://www.ietf.org/rfc/rfc3262.txt">RFC3262</a>. <li> AllowEventsHeader - this header is specific to the event notification framework. This functionality is defined in <a href = "http://www.ietf.org/rfc/rfc3265.txt">RFC3265</a>. <li> EventHeader - this header is specific to the event notification framework. This functionality is defined in <a href = "http://www.ietf.org/rfc/rfc3265.txt">RFC3265</a>. <li> SubscriptionStateHeader - this header is specific to the event notification framework. This functionality is defined in <a href = "http://www.ietf.org/rfc/rfc3265.txt">RFC3265</a>. <li> ReasonHeader - The Reason Header provides information on why a SIP request was issued, often useful when creating services and used to encapsulate a final status code in a provisional response. This functionality is defined in <a href = "http://www.ietf.org/rfc/rfc3326.txt">RFC3326</a>. </ul> SIP header fields are similar to HTTP header fields in both syntax and semantics. Some header fields only make sense in requests or responses. These are called request header fields and response header fields, respectively. If a header field appears in a message not matching its category (such as a request header field in a response), it MUST be ignored. <p><b>Header Handling</b>:<br> Any SIP header whose grammar is of the form: <br> <center>header = "header-name" HCOLON header-value *(COMMA header-value) </center> <br> allows for combining header fields of the same name into a comma-separated list. In this specification each Header object has a single value or attribute pair. For example a Header whose grammer is of the form: <br> <center>Allow: Invite, Bye;</center> <br> would be represented in a SIP message with two AllowHeader objects each containing a single attribute, Invite and Bye respectively. Implementations MUST be able to parse multiple header field rows with the same name in any combination of the single-value-per-line or comma-separated value forms and translate them into the relevent Header objects defined in this specification. <p> The relative order of header objects within messages is not significant. However, it is RECOMMENDED that required header and headers which are needed for proxy processing (Via, Route, Record-Route, Proxy-Require, Max-Forwards, and Proxy-Authorization, for example) appear towards the top of the message to facilitate rapid parsing. <p> The relative order of header objects with the same field name is important. Multiple headers with the same name MAY be present in a message if and only if the entire field-value for that header field can be defined as a comma-separated list as defined by RFC 3261. The exceptions to this rule are the WWW-Authenticate, Authorization, Proxy-Authenticate, and Proxy-Authorization header fields. Multiple header objects with these names MAY be present in a message, but since their grammar does not follow the general form listed above, they MUST NOT be combined into a single header field row when sent over the network. <p> Even though an arbitrary number of parameter pairs may be attached to a header object, any given parameter-name MUST NOT appear more than once.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>BEA Systems, NIST</DD>
</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> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/sip/header/Header.html#clone()">clone</A></B>()</CODE>
<BR>
Creates and returns a deep copy of the Header.</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/header/Header.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE>
<BR>
Compare this SIP Header for equality with another.</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/header/Header.html#getName()">getName</A></B>()</CODE>
<BR>
Gets the unique string name of this Header.</TD>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -