httpsession.html

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

<DD>Sets the language this session is using.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>language</CODE> - the language this session is using.</DL>
</DD>
</DL>
<HR>

<A NAME="getLanguage()"><!-- --></A><H3>
getLanguage</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>getLanguage</B>()</PRE>
<DL>
<DD>Returns the language this session is using.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the language this session is using.</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxPollingInterval(int)"><!-- --></A><H3>
setMaxPollingInterval</H3>
<PRE>
public void <B>setMaxPollingInterval</B>(int&nbsp;maxPollingInterval)</PRE>
<DL>
<DD>Sets the max interval within which a client can send polling requests. If more than one
 request occurs in the interval the session will be terminated.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>maxPollingInterval</CODE> - time in seconds a client needs to wait before sending polls to the
 server, a negative <i>int</i> indicates that there is no limit.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxPollingInterval()"><!-- --></A><H3>
getMaxPollingInterval</H3>
<PRE>
public int <B>getMaxPollingInterval</B>()</PRE>
<DL>
<DD>Returns the max interval within which a client can send polling requests. If more than one
 request occurs in the interval the session will be terminated.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the max interval within which a client can send polling requests. If more than one
         request occurs in the interval the session will be terminated.</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxRequests(int)"><!-- --></A><H3>
setMaxRequests</H3>
<PRE>
public void <B>setMaxRequests</B>(int&nbsp;maxRequests)</PRE>
<DL>
<DD>The max number of requests it is permissable for this session to have open at any one time.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>maxRequests</CODE> - The max number of requests it is permissable for this session to have open
 at any one time.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxRequests()"><!-- --></A><H3>
getMaxRequests</H3>
<PRE>
public int <B>getMaxRequests</B>()</PRE>
<DL>
<DD>Returns the max number of requests it is permissable for this session to have open at any one
 time.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the max number of requests it is permissable for this session to have open at any one
         time.</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxPause(int)"><!-- --></A><H3>
setMaxPause</H3>
<PRE>
public void <B>setMaxPause</B>(int&nbsp;maxPause)</PRE>
<DL>
<DD>Sets the maximum length of a temporary session pause (in seconds) that the client MAY
 request.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>maxPause</CODE> - the maximum length of a temporary session pause (in seconds) that the client
 MAY request.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxPause()"><!-- --></A><H3>
getMaxPause</H3>
<PRE>
public int <B>getMaxPause</B>()</PRE>
<DL>
<DD>Returns the maximum length of a temporary session pause (in seconds) that the client MAY
 request.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the maximum length of a temporary session pause (in seconds) that the client MAY
         request.</DL>
</DD>
</DL>
<HR>

<A NAME="isSecure()"><!-- --></A><H3>
isSecure</H3>
<PRE>
public boolean <B>isSecure</B>()</PRE>
<DL>
<DD>Returns true if all connections on this session should be secured, and false if they should
 not.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/Session.html#isSecure()">isSecure</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#isSecure()">isSecure</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 all connections on this session should be secured, and false if they should
         not.</DL>
</DD>
</DL>
<HR>

<A NAME="isPollingSession()"><!-- --></A><H3>
isPollingSession</H3>
<PRE>
public boolean <B>isPollingSession</B>()</PRE>
<DL>
<DD>Returns true if this session is a polling session. Some clients may be restricted to open
 only one connection to the server. In this case the client SHOULD inform the server by
 setting the values of the 'wait' and/or 'hold' attributes in its session creation request
 to "0", and then "poll" the server at regular intervals throughout the session for stanzas
 it may have received from the server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if this session is a polling session.</DL>
</DD>
</DL>
<HR>

<A NAME="addSessionCloseListener(org.jivesoftware.openfire.http.SessionListener)"><!-- --></A><H3>
addSessionCloseListener</H3>
<PRE>
public void <B>addSessionCloseListener</B>(<A HREF="../../../../org/jivesoftware/openfire/http/SessionListener.html" title="interface in org.jivesoftware.openfire.http">SessionListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Adds a <A HREF="../../../../org/jivesoftware/openfire/http/SessionListener.html" title="interface in org.jivesoftware.openfire.http"><CODE>SessionListener</CODE></A> to this session. The listener
 will be notified of changes to the session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener which is being added to the session.</DL>
</DD>
</DL>
<HR>

<A NAME="removeSessionCloseListener(org.jivesoftware.openfire.http.SessionListener)"><!-- --></A><H3>
removeSessionCloseListener</H3>
<PRE>
public void <B>removeSessionCloseListener</B>(<A HREF="../../../../org/jivesoftware/openfire/http/SessionListener.html" title="interface in org.jivesoftware.openfire.http">SessionListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Removes a <A HREF="../../../../org/jivesoftware/openfire/http/SessionListener.html" title="interface in org.jivesoftware.openfire.http"><CODE>SessionListener</CODE></A> from this session. The
 listener will no longer be updated when an event occurs on the session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the session listener that is to be removed.</DL>
</DD>
</DL>
<HR>

<A NAME="setDefaultInactivityTimeout(int)"><!-- --></A><H3>
setDefaultInactivityTimeout</H3>
<PRE>
public void <B>setDefaultInactivityTimeout</B>(int&nbsp;defaultInactivityTimeout)</PRE>
<DL>
<DD>Sets the default inactivity timeout of this session. A session's inactivity timeout can
 be temporarily changed using session pause requests.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>defaultInactivityTimeout</CODE> - the default inactivity timeout of this session.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/http/HttpSession.html#pause(int)"><CODE>pause(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setInactivityTimeout(int)"><!-- --></A><H3>
setInactivityTimeout</H3>
<PRE>
public void <B>setInactivityTimeout</B>(int&nbsp;inactivityTimeout)</PRE>
<DL>
<DD>Sets the time, in seconds, after which this session will be considered inactive and be be
 terminated.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>inactivityTimeout</CODE> - the time, in seconds, after which this session will be considered
 inactive and be terminated.</DL>
</DD>
</DL>
<HR>

<A NAME="resetInactivityTimeout()"><!-- --></A><H3>
resetInactivityTimeout</H3>
<PRE>
public void <B>resetInactivityTimeout</B>()</PRE>
<DL>
<DD>Resets the inactivity timeout of this session to default. A session's inactivity timeout can
 be temporarily changed using session pause requests.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/http/HttpSession.html#pause(int)"><CODE>pause(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getInactivityTimeout()"><!-- --></A><H3>
getInactivityTimeout</H3>
<PRE>
public int <B>getInactivityTimeout</B>()</PRE>
<DL>
<DD>Returns the time, in seconds, after which this session will be considered inactive and
 terminated.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the time, in seconds, after which this session will be considered inactive and
         terminated.</DL>
</DD>
</DL>
<HR>