httpsession.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The max number of requests it is permissable for this session to have open at any one time.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/http/HttpSession.html#setMinorVersion(int)">setMinorVersion</A></B>(int&nbsp;minorVersion)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the minor version of BOSH which the client implements.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/http/HttpSession.html#setSecure(boolean)">setSecure</A></B>(boolean&nbsp;isSecure)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets whether the initial request on the session was secure.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/http/HttpSession.html#setWait(int)">setWait</A></B>(int&nbsp;wait)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies the longest time (in seconds) that the connection manager is allowed to wait before
 responding to any request during the session.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.jivesoftware.openfire.session.LocalClientSession"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.jivesoftware.openfire.session.<A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html" title="class in org.jivesoftware.openfire.session">LocalClientSession</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#canFloodOfflineMessages()">canFloodOfflineMessages</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#canProcess(org.xmpp.packet.Packet)">canProcess</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#createSession(java.lang.String, org.xmlpull.v1.XmlPullParser, org.jivesoftware.openfire.Connection)">createSession</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getActiveList()">getActiveList</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getAllowedAnonymIPs()">getAllowedAnonymIPs</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getAllowedIPs()">getAllowedIPs</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getAuthToken()">getAuthToken</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getCompressionPolicy()">getCompressionPolicy</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getDefaultList()">getDefaultList</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getPresence()">getPresence</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getTLSPolicy()">getTLSPolicy</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getUsername()">getUsername</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#incrementConflictCount()">incrementConflictCount</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#isAllowed(org.jivesoftware.openfire.Connection)">isAllowed</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#isAnonymousUser()">isAnonymousUser</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#isInitialized()">isInitialized</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#isOfflineFloodStopped()">isOfflineFloodStopped</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setActiveList(org.jivesoftware.openfire.privacy.PrivacyList)">setActiveList</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setAllowedAnonymIPs(java.util.Map)">setAllowedAnonymIPs</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setAllowedIPs(java.util.Map)">setAllowedIPs</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setAnonymousAuth()">setAnonymousAuth</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setAuthToken(org.jivesoftware.openfire.auth.AuthToken)">setAuthToken</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setAuthToken(org.jivesoftware.openfire.auth.AuthToken, java.lang.String)">setAuthToken</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setCompressionPolicy(org.jivesoftware.openfire.Connection.CompressionPolicy)">setCompressionPolicy</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setDefaultList(org.jivesoftware.openfire.privacy.PrivacyList)">setDefaultList</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setInitialized(boolean)">setInitialized</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setOfflineFloodStopped(boolean)">setOfflineFloodStopped</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setPresence(org.xmpp.packet.Presence)">setPresence</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#setTLSPolicy(org.jivesoftware.openfire.Connection.TLSPolicy)">setTLSPolicy</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#toString()">toString</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#wasAvailable()">wasAvailable</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.jivesoftware.openfire.session.LocalSession"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.jivesoftware.openfire.session.<A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html" title="class in org.jivesoftware.openfire.session">LocalSession</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#decodeVersion(java.lang.String)">decodeVersion</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#deliverRawText(java.lang.String)">deliverRawText</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getAddress()">getAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getConnection()">getConnection</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getCreationDate()">getCreationDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getHostAddress()">getHostAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getHostName()">getHostName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getLastActiveDate()">getLastActiveDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getNumClientPackets()">getNumClientPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getNumServerPackets()">getNumServerPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getServerName()">getServerName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getSessionData(java.lang.String)">getSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getStatus()">getStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getStreamID()">getStreamID</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#incrementClientPacketCount()">incrementClientPacketCount</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#incrementServerPacketCount()">incrementServerPacketCount</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#isUsingSelfSignedCertificate()">isUsingSelfSignedCertificate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#process(org.xmpp.packet.Packet)">process</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#removeSessionData(java.lang.String)">removeSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setAddress(org.xmpp.packet.JID)">setAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setSessionData(java.lang.String, java.lang.Object)">setSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setStatus(int)">setStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#validate()">validate</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.jivesoftware.openfire.session.Session"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.jivesoftware.openfire.session.<A HREF="../../../../org/jivesoftware/openfire/session/Session.html" title="interface in org.jivesoftware.openfire.session">Session</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/Session.html#deliverRawText(java.lang.String)">deliverRawText</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getAddress()">getAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getCreationDate()">getCreationDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getHostAddress()">getHostAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getHostName()">getHostName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getLastActiveDate()">getLastActiveDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getNumClientPackets()">getNumClientPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getNumServerPackets()">getNumServerPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getServerName()">getServerName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getStatus()">getStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getStreamID()">getStreamID</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#process(org.xmpp.packet.Packet)">process</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#validate()">validate</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="HttpSession(org.jivesoftware.openfire.PacketDeliverer, java.lang.String, java.net.InetAddress, org.jivesoftware.openfire.StreamID, long, org.jivesoftware.openfire.http.HttpConnection)"><!-- --></A><H3>
HttpSession</H3>
<PRE>
public <B>HttpSession</B>(<A HREF="../../../../org/jivesoftware/openfire/PacketDeliverer.html" title="interface in org.jivesoftware.openfire">PacketDeliverer</A>&nbsp;backupDeliverer,
                   <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;serverName,
                   <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A>&nbsp;address,
                   <A HREF="../../../../org/jivesoftware/openfire/StreamID.html" title="interface in org.jivesoftware.openfire">StreamID</A>&nbsp;streamID,
                   long&nbsp;rid,
                   <A HREF="../../../../org/jivesoftware/openfire/http/HttpConnection.html" title="class in org.jivesoftware.openfire.http">HttpConnection</A>&nbsp;connection)</PRE>
<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="getAvailableStreamFeaturesElements()"><!-- --></A><H3>
getAvailableStreamFeaturesElements</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;org.dom4j.Element&gt; <B>getAvailableStreamFeaturesElements</B>()</PRE>
<DL>
<DD>Returns the stream features which are available for this session.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the stream features which are available for this session.</DL>
</DD>
</DL>
<HR>

<A NAME="getAvailableStreamFeatures()"><!-- --></A><H3>
getAvailableStreamFeatures</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getAvailableStreamFeatures</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getAvailableStreamFeatures()">LocalSession</A></CODE></B></DD>
<DD>Returns a text with the available stream features. Each subclass may return different
 values depending whether the session has been authenticated or not.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getAvailableStreamFeatures()">getAvailableStreamFeatures</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html" title="class in org.jivesoftware.openfire.session">LocalClientSession</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a text with the available stream features or <tt>null</tt> to add nothing.</DL>
</DD>
</DL>
<HR>

<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()</PRE>
<DL>
<DD>Closes the session. After a session has been closed it will no longer accept new connections
 on the session ID.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/Session.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/Session.html" title="interface in org.jivesoftware.openfire.session">Session</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#close()">close</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html" title="class in org.jivesoftware.openfire.session">LocalSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isClosed()"><!-- --></A><H3>
isClosed</H3>
<PRE>
public boolean <B>isClosed</B>()</PRE>
<DL>
<DD>Returns true if this session has been closed and no longer activley accepting connections.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/Session.html#isClosed()">isClosed</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/Session.html" title="interface in org.jivesoftware.openfire.session">Session</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#isClosed()">isClosed</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html" title="class in org.jivesoftware.openfire.session">LocalSession</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if this session has been closed and no longer activley accepting connections.</DL>
</DD>
</DL>
<HR>

<A NAME="setWait(int)"><!-- --></A><H3>
setWait</H3>
<PRE>
public void <B>setWait</B>(int&nbsp;wait)</PRE>
<DL>
<DD>Specifies the longest time (in seconds) that the connection manager is allowed to wait before
 responding to any request during the session. This enables the client to prevent its TCP
 connection from expiring due to inactivity, as well as to limit the delay before it discovers
 any network failure.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>wait</CODE> - the longest time it is permissible to wait for a response.</DL>
</DD>
</DL>
<HR>

<A NAME="getWait()"><!-- --></A><H3>
getWait</H3>
<PRE>
public int <B>getWait</B>()</PRE>
<DL>
<DD>Specifies the longest time (in seconds) that the connection manager is allowed to wait before
 responding to any request during the session. This enables the client to prevent its TCP
 connection from expiring due to inactivity, as well as to limit the delay before it discovers
 any network failure.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the longest time it is permissible to wait for a response.</DL>
</DD>
</DL>
<HR>

<A NAME="setHold(int)"><!-- --></A><H3>
setHold</H3>
<PRE>
public void <B>setHold</B>(int&nbsp;hold)</PRE>
<DL>
<DD>Specifies the maximum number of requests the connection manager is allowed to keep waiting at
 any one time during the session. (For example, if a constrained client is unable to keep open
 more than two HTTP connections to the same HTTP server simultaneously, then it SHOULD specify
 a value of "1".)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>hold</CODE> - the maximum number of simultaneous waiting requests.</DL>
</DD>
</DL>
<HR>

<A NAME="getHold()"><!-- --></A><H3>
getHold</H3>
<PRE>
public int <B>getHold</B>()</PRE>
<DL>
<DD>Specifies the maximum number of requests the connection manager is allowed to keep waiting at
 any one time during the session. (For example, if a constrained client is unable to keep open
 more than two HTTP connections to the same HTTP server simultaneously, then it SHOULD specify
 a value of "1".)
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the maximum number of simultaneous waiting requests</DL>
</DD>
</DL>
<HR>

<A NAME="setLanguage(java.lang.String)"><!-- --></A><H3>
setLanguage</H3>
<PRE>
public void <B>setLanguage</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;language)</PRE>
<DL>