📄 subscriptionstateheader.html
字号:
<PRE>
static final java.lang.String <B>UNKNOWN</B></PRE>
<DL>
<DD>Reason Code: The reason why the subscription was terminated is Unknown.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.UNKNOWN">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DEACTIVATED"><!-- --></A><H3>
DEACTIVATED</H3>
<PRE>
static final java.lang.String <B>DEACTIVATED</B></PRE>
<DL>
<DD>Reason Code: The subscription has been terminated, but the subscriber SHOULD retry immediately with a new subscription. One primary use of such a status code is to allow migration of subscriptions between nodes. The "retry-after" parameter has no semantics for "deactivated".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.DEACTIVATED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PROBATION"><!-- --></A><H3>
PROBATION</H3>
<PRE>
static final java.lang.String <B>PROBATION</B></PRE>
<DL>
<DD>Reason Code: The subscription has been terminated, but the client SHOULD retry at some later time. If a "retry-after" parameter is also present, the client SHOULD wait at least the number of seconds specified by that parameter before attempting to re-subscribe.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.PROBATION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="REJECTED"><!-- --></A><H3>
REJECTED</H3>
<PRE>
static final java.lang.String <B>REJECTED</B></PRE>
<DL>
<DD>Reason Code: The subscription has been terminated due to change in authorization policy. Clients SHOULD NOT attempt to re-subscribe. The "retry-after" parameter has no semantics for "rejected".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.REJECTED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TIMEOUT"><!-- --></A><H3>
TIMEOUT</H3>
<PRE>
static final java.lang.String <B>TIMEOUT</B></PRE>
<DL>
<DD>Reason Code: The subscription has been terminated because it was not refreshed before it expired. Clients MAY re-subscribe immediately. The "retry-after" parameter has no semantics for "timeout".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.TIMEOUT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="GIVE_UP"><!-- --></A><H3>
GIVE_UP</H3>
<PRE>
static final java.lang.String <B>GIVE_UP</B></PRE>
<DL>
<DD>Reason Code: The subscription has been terminated because the notifier could not obtain authorization in a timely fashion. If a "retry-after" parameter is also present, the client SHOULD wait at least the number of seconds specified by that parameter before attempting to re-subscribe; otherwise, the client MAY retry immediately, but will likely get put back into pending state.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.GIVE_UP">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NO_RESOURCE"><!-- --></A><H3>
NO_RESOURCE</H3>
<PRE>
static final java.lang.String <B>NO_RESOURCE</B></PRE>
<DL>
<DD>Reason Code: The subscription has been terminated because the resource state which was being monitored no longer exists. Clients SHOULD NOT attempt to re-subscribe. The "retry-after" parameter has no semantics for "noresource".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.NO_RESOURCE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ACTIVE"><!-- --></A><H3>
ACTIVE</H3>
<PRE>
static final java.lang.String <B>ACTIVE</B></PRE>
<DL>
<DD>State: The subscription has been accepted and (in general) has been authorized.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.ACTIVE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TERMINATED"><!-- --></A><H3>
TERMINATED</H3>
<PRE>
static final java.lang.String <B>TERMINATED</B></PRE>
<DL>
<DD>State: The subscription has been terminated, if a reason code is present, the client should behave as described in the reason code.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.TERMINATED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PENDING"><!-- --></A><H3>
PENDING</H3>
<PRE>
static final java.lang.String <B>PENDING</B></PRE>
<DL>
<DD>State: The subscription has been received by the notifier, but there is insufficient policy information to grant or deny the subscription yet.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.sip.header.SubscriptionStateHeader.PENDING">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="setExpires(int)"><!-- --></A><H3>
setExpires</H3>
<PRE>
void <B>setExpires</B>(int expires)
throws <A HREF="../../../javax/sip/InvalidArgumentException.html" title="class in javax.sip">InvalidArgumentException</A></PRE>
<DL>
<DD>Sets the relative expires value of the SubscriptionStateHeader. The expires value MUST be greater than zero and MUST be less than 2**31.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>expires</CODE> - - the new expires value of this SubscriptionStateHeader.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/sip/InvalidArgumentException.html" title="class in javax.sip">InvalidArgumentException</A></CODE> - if supplied value is less than zero.</DL>
</DD>
</DL>
<HR>
<A NAME="getExpires()"><!-- --></A><H3>
getExpires</H3>
<PRE>
int <B>getExpires</B>()</PRE>
<DL>
<DD>Gets the expires value of the SubscriptionStateHeader. This expires value is relative time.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the expires value of the SubscriptionStateHeader.</DL>
</DD>
</DL>
<HR>
<A NAME="setRetryAfter(int)"><!-- --></A><H3>
setRetryAfter</H3>
<PRE>
void <B>setRetryAfter</B>(int retryAfter)
throws <A HREF="../../../javax/sip/InvalidArgumentException.html" title="class in javax.sip">InvalidArgumentException</A></PRE>
<DL>
<DD>Sets the retry after value of the SubscriptionStateHeader. The retry after value MUST be greater than zero and MUST be less than 2**31.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>retryAfter</CODE> - - the new retry after value of this SubscriptionStateHeader
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/sip/InvalidArgumentException.html" title="class in javax.sip">InvalidArgumentException</A></CODE> - if supplied value is less than zero.</DL>
</DD>
</DL>
<HR>
<A NAME="getRetryAfter()"><!-- --></A><H3>
getRetryAfter</H3>
<PRE>
int <B>getRetryAfter</B>()</PRE>
<DL>
<DD>Gets the retry after value of the SubscriptionStateHeader. This retry after value is relative time.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the retry after value of the SubscriptionStateHeader.</DL>
</DD>
</DL>
<HR>
<A NAME="getReasonCode()"><!-- --></A><H3>
getReasonCode</H3>
<PRE>
java.lang.String <B>getReasonCode</B>()</PRE>
<DL>
<DD>Gets the reason code of SubscriptionStateHeader.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the comment of this SubscriptionStateHeader, return null if no reason code is available.</DL>
</DD>
</DL>
<HR>
<A NAME="setReasonCode(java.lang.String)"><!-- --></A><H3>
setReasonCode</H3>
<PRE>
void <B>setReasonCode</B>(java.lang.String reasonCode)
throws java.text.ParseException</PRE>
<DL>
<DD>Sets the reason code value of the SubscriptionStateHeader.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reasonCode</CODE> - - the new reason code string value of the SubscriptionStateHeader.
<DT><B>Throws:</B>
<DD><CODE>java.text.ParseException</CODE> - which signals that an error has been reached unexpectedly while parsing the reason code.</DL>
</DD>
</DL>
<HR>
<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
java.lang.String <B>getState</B>()</PRE>
<DL>
<DD>Gets the state of SubscriptionStateHeader.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the state of this SubscriptionStateHeader.</DL>
</DD>
</DL>
<HR>
<A NAME="setState(java.lang.String)"><!-- --></A><H3>
setState</H3>
<PRE>
void <B>setState</B>(java.lang.String state)
throws java.text.ParseException</PRE>
<DL>
<DD>Sets the state value of the SubscriptionStateHeader.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>state</CODE> - - the new state string value of the SubscriptionStateHeader.
<DT><B>Throws:</B>
<DD><CODE>java.text.ParseException</CODE> - which signals that an error has been reached unexpectedly while parsing the state.</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> </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/SubjectHeader.html" title="interface in javax.sip.header"><B>PREV CLASS</B></A>
<A HREF="../../../javax/sip/header/SupportedHeader.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/SubscriptionStateHeader.html" target="_top"><B>FRAMES</B></A>
<A HREF="SubscriptionStateHeader.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_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<center>If you have any comments, please mail them to <a href=mailto:JAIN-SIP-INTEREST@java.sun.com>JAIN-SIP-INTEREST@java.sun.com</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>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -