|
Wildfire 3.2.4 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.wildfire.session.Session org.jivesoftware.wildfire.session.ClientSession org.jivesoftware.wildfire.http.HttpSession
public class HttpSession
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.
Nested Class Summary | |
---|---|
static class |
HttpSession.HttpVirtualConnection
A virtual server connection relates to a http session which its self can relate to many http connections. |
Field Summary |
---|
Fields inherited from class org.jivesoftware.wildfire.session.ClientSession |
---|
authToken |
Fields inherited from class org.jivesoftware.wildfire.session.Session |
---|
CHARSET, conn, MAJOR_VERSION, MINOR_VERSION, sessionManager, status, STATUS_AUTHENTICATED, STATUS_CLOSED, STATUS_CONNECTED, STATUS_STREAMING |
Constructor Summary | |
---|---|
HttpSession(PacketDeliverer backupDeliverer,
String serverName,
InetAddress address,
StreamID streamID,
long rid)
|
Method Summary | |
---|---|
void |
addSessionCloseListener(SessionListener listener)
Adds a SessionListener to this session. |
void |
close()
Closes the session. |
String |
getAvailableStreamFeatures()
Returns a text with the available stream features. |
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. |
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. |
Collection<org.dom4j.Element> |
getPacketsToSend(long time,
TimeUnit timeUnit)
Returns the next set of packets to be sent. |
String |
getResponse(long requestID)
|
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 |
releasePacketsToSend()
Releases the lock on the send packets queue so that other threads may access it. |
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(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 |
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.wildfire.session.ClientSession |
---|
canFloodOfflineMessages, canProcess, createSession, getActiveList, getAllowedIPs, getAuthToken, getCompressionPolicy, getConflictCount, getDefaultList, getPresence, getTLSPolicy, getUsername, incrementConflictCount, isInitialized, isOfflineFloodStopped, setActiveList, setAllowedIPs, setAnonymousAuth, setAuthToken, setAuthToken, setCompressionPolicy, setDefaultList, setInitialized, setOfflineFloodStopped, setPresence, setTLSPolicy, toString, wasAvailable |
Methods inherited from class org.jivesoftware.wildfire.session.Session |
---|
decodeVersion, getAddress, getConnection, getCreationDate, getLastActiveDate, getNumClientPackets, getNumServerPackets, getServerName, getSessionData, getStatus, getStreamID, incrementClientPacketCount, incrementServerPacketCount, process, removeSessionData, setAddress, setSessionData, setStatus |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public HttpSession(PacketDeliverer backupDeliverer, String serverName, InetAddress address, StreamID streamID, long rid)
Method Detail |
---|
public Collection<org.dom4j.Element> getAvailableStreamFeaturesElements()
public String getAvailableStreamFeatures()
Session
getAvailableStreamFeatures
in class ClientSession
public void close()
public boolean isClosed()
public void setWait(int wait)
wait
- the longest time it is permissible to wait for a response.public int getWait()
public void setHold(int hold)
hold
- the maximum number of simultaneous waiting requests.public int getHold()
public void setLanaguage(String language)
language
- the language this session is using.public String getLanguage()
public void setMaxPollingInterval(int maxPollingInterval)
maxPollingInterval
- time in seconds a client needs to wait before sending polls to the
server, a negative int indicates that there is no limit.public int getMaxPollingInterval()
public void setMaxRequests(int maxRequests)
maxRequests
- The max number of requests it is permissable for this session to have open
at any one time.public int getMaxRequests()
public boolean isSecure()
public void addSessionCloseListener(SessionListener listener)
SessionListener
to this session. The listener
will be notified of changes to the session.
listener
- the listener which is being added to the session.public void removeSessionCloseListener(SessionListener listener)
SessionListener
from this session. The
listener will no longer be updated when an event occurs on the session.
listener
- the session listener that is to be removed.public void setInactivityTimeout(int inactivityTimeout)
inactivityTimeout
- the time, in seconds, after which this session will be considered
inactive and be terminated.public int getInactivityTimeout()
public long getLastActivity()
public String getResponse(long requestID) throws HttpBindException
HttpBindException
protected void setSecure(boolean isSecure)
isSecure
- true if the initial request was secure and false if it wasn't.public Collection<org.dom4j.Element> getPacketsToSend(long time, TimeUnit timeUnit)
releasePacketsToSend()
needs to be called.
time
- the quantity of time to wait for the queue to be free for consumptiontimeUnit
- the unit of time related to the quanity
public void releasePacketsToSend()
|
Wildfire 3.2.4 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |