Interface SessionManager
-
public interface SessionManager
- Author:
- arthurm
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addToSessionMap(javax.servlet.http.HttpSession session)
Add the session to the session map.Session
createSession()
Creates a new session out of thin air.Session
createSession(int webid)
Creates a new session for the specified website ID.Session
createSession(int webid, String username)
Creates a new session for the specified user and website ID.Session
createSession(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Creates a new session for the specified request and response.Session
getActiveSession()
Returns the currently active session.int
getWebIdFromServerName(String serverName)
Returns the web id corresponding to the servername, or -1 is no web id can be found for the provided servernamevoid
removeFromSessionMap(javax.servlet.http.HttpSession session)
Remove the session from the session map.
-
-
-
Method Detail
-
getActiveSession
Session getActiveSession()
Returns the currently active session.- Returns:
- Returns the currently active session or
null
if no WebManager session is currently active.
-
createSession
Session createSession(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Creates a new session for the specified request and response.- Parameters:
req
- The request objectres
- The response object- Returns:
- The created session for accessing WebManager
-
createSession
Session createSession()
Creates a new session out of thin air.- Returns:
- The created session for accessing WebManager
-
createSession
Session createSession(int webid)
Creates a new session for the specified website ID.- Parameters:
webid
- the id of the website for which a session should be created- Returns:
- The created session for accessing WebManager
-
createSession
Session createSession(int webid, String username)
Creates a new session for the specified user and website ID.- Parameters:
webid
- the id of the website for which a session should be createdusername
- the username of the user for which a session should be created. Can be null- Returns:
- The created session for accessing WebManager
-
addToSessionMap
void addToSessionMap(javax.servlet.http.HttpSession session)
Add the session to the session map.- Parameters:
session
- the session to add
-
removeFromSessionMap
void removeFromSessionMap(javax.servlet.http.HttpSession session)
Remove the session from the session map.- Parameters:
session
- the session to remove
-
getWebIdFromServerName
int getWebIdFromServerName(String serverName)
Returns the web id corresponding to the servername, or -1 is no web id can be found for the provided servername- Parameters:
serverName
- the servername to get the web id for- Returns:
- either the id of web id corresponding to the servername or -1 if no corresponding web id can be found
- Since:
- 10.36.0
-
-