Connection Manager 3.6.3 Javadoc

org.jivesoftware.multiplexer.net.http
Class HttpSession

java.lang.Object
  extended by org.jivesoftware.multiplexer.Session
      extended by org.jivesoftware.multiplexer.ClientSession
          extended by org.jivesoftware.multiplexer.net.http.HttpSession

public class HttpSession
extends ClientSession

A session represents a serious of interactions with an XMPP client sending packets using the HTTP Binding protocol specified in XEP-0124. A session can have several client connections open simultaneously while awaiting packets bound for the client from the server.

Author:
Alexander Wenckus

Field Summary
 
Fields inherited from class org.jivesoftware.multiplexer.Session
CHARSET, conn, idFactory, MAJOR_VERSION, MINOR_VERSION, status, STATUS_AUTHENTICATED, STATUS_CLOSED, STATUS_CONNECTED, STATUS_STREAMING
 
Constructor Summary
HttpSession(java.lang.String serverName, java.lang.String streamID, long rid)
           
 
Method Summary
 void addSessionCloseListener(SessionListener listener)
          Adds a SessionListener to this session.
 void close()
          Indicate the server that the session has been closed.
 void close(boolean isServerShuttingDown)
          Closes the client connection.
 void deliver(org.dom4j.Element stanza)
          Delivers a stanza sent by the server to the client.
 java.lang.String getAvailableStreamFeatures()
          Returns a text with the available stream features.
 java.util.Collection<org.dom4j.Element> getAvailableStreamFeaturesElements()
          Returns the stream features which are available for this session.
 int getHold()
          Specifies the maximum number of requests the connection manager is allowed to keep waiting at any one time during the session.
 int getInactivityTimeout()
          Returns the time, in seconds, after which this session will be considered inactive and terminated.
 java.lang.String getLanguage()
          Returns the language this session is using.
 long getLastActivity()
          Returns the time in milliseconds since the epoch that this session was last active.
 int getMaxPollingInterval()
          Returns the max interval within which a client can send polling requests.
 int getMaxRequests()
          Returns the max number of requests it is permissable for this session to have open at any one time.
 java.lang.String getResponse(long requestID)
           
 double getVersion()
          Returns the BOSH version which this session utilizes.
 int getWait()
          Specifies the longest time (in seconds) that the connection manager is allowed to wait before responding to any request during the session.
 boolean isClosed()
          Returns true if this session has been closed and no longer activley accepting connections.
 boolean isSecure()
          Returns true if all connections on this session should be secured, and false if they should not.
 void removeSessionCloseListener(SessionListener listener)
          Removes a SessionListener from this session.
 void setHold(int hold)
          Specifies the maximum number of requests the connection manager is allowed to keep waiting at any one time during the session.
 void setInactivityTimeout(int inactivityTimeout)
          Sets the time, in seconds, after which this session will be considered inactive and be be terminated.
 void setLanaguage(java.lang.String language)
          Sets the language this session is using.
 void setMaxPollingInterval(int maxPollingInterval)
          Sets the max interval within which a client can send polling requests.
 void setMaxRequests(int maxRequests)
          The max number of requests it is permissable for this session to have open at any one time.
protected  void setSecure(boolean isSecure)
          Sets whether the initial request on the session was secure.
 void setVersion(double version)
          Sets the version of BOSH which the client implements.
 void setWait(int wait)
          Specifies the longest time (in seconds) that the connection manager is allowed to wait before responding to any request during the session.
 
Methods inherited from class org.jivesoftware.multiplexer.ClientSession
createSession
 
Methods inherited from class org.jivesoftware.multiplexer.Session
addSession, closeAll, decodeVersion, getCreationDate, getServerName, getSession, getStatus, getStreamID, removeSession, setStatus, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HttpSession

public HttpSession(java.lang.String serverName,
                   java.lang.String streamID,
                   long rid)
Method Detail

getAvailableStreamFeaturesElements

public java.util.Collection<org.dom4j.Element> getAvailableStreamFeaturesElements()
Returns the stream features which are available for this session.

Returns:
the stream features which are available for this session.

getAvailableStreamFeatures

public java.lang.String getAvailableStreamFeatures()
Description copied from class: Session
Returns a text with the available stream features. Each subclass may return different values depending whether the session has been authenticated or not.

Overrides:
getAvailableStreamFeatures in class ClientSession
Returns:
a text with the available stream features or null to add nothing.

close

public void close()
Description copied from class: Session
Indicate the server that the session has been closed. Do nothing if the session was the one that originated the close action.

Overrides:
close in class ClientSession

close

public void close(boolean isServerShuttingDown)
Description copied from class: ClientSession
Closes the client connection. The systemStopped parameter indicates if the client connection is being closed because the server is shutting down or unavailable or if it is because the connection manager is being shutdown.

Overrides:
close in class ClientSession
Parameters:
isServerShuttingDown - true when the server is no longer available or the connection manager is being shutdown.

isClosed

public boolean isClosed()
Returns true if this session has been closed and no longer activley accepting connections.

Overrides:
isClosed in class ClientSession
Returns:
true if this session has been closed and no longer activley accepting connections.

setWait

public void setWait(int wait)
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.

Parameters:
wait - the longest time it is permissible to wait for a response.

getWait

public int getWait()
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.

Returns:
the longest time it is permissible to wait for a response.

setHold

public void setHold(int hold)
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".)

Parameters:
hold - the maximum number of simultaneous waiting requests.

getHold

public int getHold()
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".)

Returns:
the maximum number of simultaneous waiting requests

setLanaguage

public void setLanaguage(java.lang.String language)
Sets the language this session is using.

Parameters:
language - the language this session is using.

getLanguage

public java.lang.String getLanguage()
Returns the language this session is using.

Returns:
the language this session is using.

setMaxPollingInterval

public void setMaxPollingInterval(int maxPollingInterval)
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.

Parameters:
maxPollingInterval - time in seconds a client needs to wait before sending polls to the server, a negative int indicates that there is no limit.

getMaxPollingInterval

public int getMaxPollingInterval()
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.

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.

setMaxRequests

public void setMaxRequests(int maxRequests)
The max number of requests it is permissable for this session to have open at any one time.

Parameters:
maxRequests - The max number of requests it is permissable for this session to have open at any one time.

getMaxRequests

public int getMaxRequests()
Returns the max number of requests it is permissable for this session to have open at any one time.

Returns:
the max number of requests it is permissable for this session to have open at any one time.

isSecure

public boolean isSecure()
Returns true if all connections on this session should be secured, and false if they should not.

Returns:
true if all connections on this session should be secured, and false if they should not.

addSessionCloseListener

public void addSessionCloseListener(SessionListener listener)
Adds a SessionListener to this session. The listener will be notified of changes to the session.

Parameters:
listener - the listener which is being added to the session.

removeSessionCloseListener

public void removeSessionCloseListener(SessionListener listener)
Removes a SessionListener from this session. The listener will no longer be updated when an event occurs on the session.

Parameters:
listener - the session listener that is to be removed.

setInactivityTimeout

public void setInactivityTimeout(int inactivityTimeout)
Sets the time, in seconds, after which this session will be considered inactive and be be terminated.

Parameters:
inactivityTimeout - the time, in seconds, after which this session will be considered inactive and be terminated.

getInactivityTimeout

public int getInactivityTimeout()
Returns the time, in seconds, after which this session will be considered inactive and terminated.

Returns:
the time, in seconds, after which this session will be considered inactive and terminated.

getLastActivity

public long getLastActivity()
Returns the time in milliseconds since the epoch that this session was last active. Activity is a request was either made or responded to. If the session is currently active, meaning there are connections awaiting a response, the current time is returned.

Returns:
the time in milliseconds since the epoch that this session was last active.

setVersion

public void setVersion(double version)
Sets the version of BOSH which the client implements. Currently, the only versions supported by Openfire are 1.5 and 1.6. Any versions less than or equal to 1.5 will be interpreted as 1.5 and any values greater than or equal to 1.6 will be interpreted as 1.6.

Parameters:
version - the version of BOSH which the client implements, represented as a Double, {major version}.{minor version}.

getVersion

public double getVersion()
Returns the BOSH version which this session utilizes. The version refers to the version of the XEP which the connecting client implements. If the client did not specify a version 1.5 is returned as this is the last version of the XEP that the client was not required to pass along its version information when creating a session.

Returns:
the version of the BOSH XEP which the client is utilizing.

getResponse

public java.lang.String getResponse(long requestID)
                             throws HttpBindException
Throws:
HttpBindException

setSecure

protected void setSecure(boolean isSecure)
Sets whether the initial request on the session was secure.

Parameters:
isSecure - true if the initial request was secure and false if it wasn't.

deliver

public void deliver(org.dom4j.Element stanza)
Description copied from class: ClientSession
Delivers a stanza sent by the server to the client.

Overrides:
deliver in class ClientSession
Parameters:
stanza - the stanza sent by the server.

Connection Manager 3.6.3 Javadoc

Copyright © 2003-2006 Jive Software.